apipie-rails 0.3.6 → 0.5.17

data/spec/lib/validator_spec.rb

@@ -42,6 +42,29 @@ describe Apipie::Validator do
 
     end
 
+    describe 'NumberValidator' do
+      it 'should expect a Numeric type' do
+        validator = Apipie::Validator::BaseValidator.find(params_desc, :number, nil, nil)
+        expect(validator.expected_type).to eq('numeric')
+      end
+    end
+  end
+
+  describe 'BooleanValidator' do
+    it "should validate by object class" do
+      validator = Apipie::Validator::BooleanValidator.new(params_desc)
+      expect(validator.validate("1")).to be_truthy
+      expect(validator.validate(1)).to be_truthy
+      expect(validator.validate(true)).to be_truthy
+      expect(validator.validate(0)).to be_truthy
+      expect(validator.validate(false)).to be_truthy
+      expect(validator.validate({ 1 => 1 })).to be_falsey
+    end
+
+    it "should have a valid description" do
+      validator = Apipie::Validator::BooleanValidator.new(params_desc)
+      expect(validator.description).to eq('Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.')
+    end
   end
 
   describe 'ArrayClassValidator' do
@@ -51,5 +74,40 @@ describe Apipie::Validator do
       expect(validator.validate(1)).to be_truthy
       expect(validator.validate({ 1 => 1 })).to be_falsey
     end
+
+    it "should have a valid description" do
+      validator = Apipie::Validator::ArrayClassValidator.new(params_desc, [Float, String])
+      expect(validator.description).to eq('Must be one of: <code>Float</code>, <code>String</code>.')
+    end
+  end
+
+  describe 'RegexpValidator' do
+    it "should validate by object class" do
+      validator = Apipie::Validator::RegexpValidator.new(params_desc, /^valid( extra)*$/)
+      expect(validator.validate("valid")).to be_truthy
+      expect(validator.validate("valid extra")).to be_truthy
+      expect(validator.validate("valid extra extra")).to be_truthy
+      expect(validator.validate("invalid")).to be_falsey
+    end
+
+    it "should have a valid description" do
+      validator = Apipie::Validator::RegexpValidator.new(params_desc, /^valid( extra)*$/)
+      expect(validator.description).to eq('Must match regular expression <code>/^valid( extra)*$/</code>.')
+    end
+  end
+
+  describe 'EnumValidator' do
+    it "should validate by object class" do
+      validator = Apipie::Validator::EnumValidator.new(params_desc, ['first', 'second & third'])
+      expect(validator.validate("first")).to be_truthy
+      expect(validator.validate("second & third")).to be_truthy
+      expect(validator.validate(1)).to be_falsey
+      expect(validator.validate({ 1 => 1 })).to be_falsey
+    end
+
+    it "should have a valid description" do
+      validator = Apipie::Validator::EnumValidator.new(params_desc, ['first', 'second & third'])
+      expect(validator.description).to eq('Must be one of: <code>first</code>, <code>second &amp; third</code>.')
+    end
   end
 end

data/spec/lib/validators/array_validator_spec.rb

@@ -24,18 +24,38 @@ module Apipie::Validator
     end
 
     context "with a constraint on items type" do
-      let(:validator) { ArrayValidator.new(param_desc, Array, :of => String) }
+      let(:validator) { ArrayValidator.new(param_desc, Array, :of => type) }
 
-      it "accepts array of specified type" do
-        expect(validator.validate(['string1', 'string2'])).to eq(true)
-      end
+      context "String" do
+        let(:type) { String }
 
-      it "accepts empty array" do
-        expect(validator.validate([])).to eq(true)
+        it "accepts array of specified type" do
+          expect(validator.validate(['string1', 'string2'])).to eq(true)
+        end
+
+        it "accepts empty array" do
+          expect(validator.validate([])).to eq(true)
+        end
+
+        it "does not accepts array with other types" do
+          expect(validator.validate(['string1', true])).to eq(false)
+        end
       end
 
-      it "does not accepts array with other types" do
-        expect(validator.validate(['string1', true])).to eq(false)
+      context ":number" do
+        let(:type) { :decimal }
+
+        it "accepts array of specified type" do
+          expect(validator.validate([12, '14'])).to eq(true)
+        end
+
+        it "accepts empty array" do
+          expect(validator.validate([])).to eq(true)
+        end
+
+        it "does not accepts array with other types" do
+          expect(validator.validate([12, 'potato'])).to eq(false)
+        end
       end
     end
 

data/spec/spec_helper.rb

@@ -8,6 +8,71 @@ require File.expand_path("../dummy/config/environment", __FILE__)
 require 'rspec/rails'
 
 require 'apipie-rails'
+require 'test_engine'
+
+module Rails4Compatibility
+  module Testing
+    def process(*args)
+      compatible_request(*args) { |*new_args| super(*new_args) }
+    end
+
+    def compatible_request(method, action, hash = {})
+      if hash.is_a?(Hash)
+        if Gem::Version.new(Rails.version) < Gem::Version.new('5.0.0')
+          hash = hash.dup
+          hash.merge!(hash.delete(:params) || {})
+        elsif hash.key?(:params)
+          hash = { :params => hash }
+        end
+      end
+      if hash.empty?
+        yield method, action
+      else
+        yield method, action, hash
+      end
+    end
+  end
+end
+
+
+#
+# Matcher to validate the properties (name, type and options) of a single field in the
+# internal representation of a swagger schema
+#
+# For example, code such as:
+#       schema = swagger[:paths][<path>][<method>][:responses][<code>][:schema]
+#       expect(schema).to have_field(:pet_name, 'string', {:required => false})
+#
+# will verify that the selected response schema includes a required string field called 'pet_name'
+#
+RSpec::Matchers.define :have_field do |name, type, opts={}|
+  def fail(msg)
+    @fail_message = msg
+    false
+  end
+
+  @fail_message = ""
+
+  failure_message do |actual|
+    @fail_message
+  end
+
+  match do |unresolved|
+    actual = resolve_refs(unresolved)
+    return fail("expected schema to have type 'object' (got '#{actual[:type]}')") if (actual[:type]) != 'object'
+    return fail("expected schema to include param named '#{name}' (got #{actual[:properties].keys})") if (prop = actual[:properties][name]).nil?
+    return fail("expected param '#{name}' to have type '#{type}' (got '#{prop[:type]}')") if prop[:type] != type
+    return fail("expected param '#{name}' to have description '#{opts[:description]}' (got '#{prop[:description]}')") if opts[:description] && prop[:description] != opts[:description]
+    return fail("expected param '#{name}' to have enum '#{opts[:enum]}' (got #{prop[:enum]})") if opts[:enum] && prop[:enum] != opts[:enum]
+    return fail("expected param '#{name}' to have items '#{opts[:items]}' (got #{prop[:items]})") if opts[:items] && prop[:items] != opts[:items]
+    if !opts.include?(:required) || opts[:required] == true
+      return fail("expected param '#{name}' to be required") unless actual[:required].include?(name)
+    else
+      return fail("expected param '#{name}' to be optional") if actual[:required].include?(name)
+    end
+    true
+  end
+end
 
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.
@@ -41,3 +106,6 @@ RSpec.configure do |config|
   #     end
   config.infer_spec_type_from_file_location!
 end
+
+require 'action_controller/test_case.rb'
+ActionController::TestCase::Behavior.send(:prepend, Rails4Compatibility::Testing)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.5.17
 platform: ruby
 authors:
 - Pavel Pokorny
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-18 00:00:00.000000000 Z
+date: 2020-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,28 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.20
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.20
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -137,6 +123,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
 description: Rails REST API documentation tool
 email:
 - pajkycz@gmail.com
@@ -151,12 +151,14 @@ files:
 - APACHE-LICENSE-2.0
 - CHANGELOG.md
 - Gemfile
-- Gemfile.rails32
-- Gemfile.rails40
 - Gemfile.rails41
 - Gemfile.rails42
+- Gemfile.rails50
+- Gemfile.rails51
+- Gemfile.rails60
 - MIT-LICENSE
 - NOTICE
+- PROPOSAL_FOR_RESPONSE_DESCRIPTIONS.md
 - README.rst
 - Rakefile
 - apipie-rails.gemspec
@@ -191,6 +193,9 @@ files:
 - config/locales/de.yml
 - config/locales/en.yml
 - config/locales/es.yml
+- config/locales/fr.yml
+- config/locales/it.yml
+- config/locales/ja.yml
 - config/locales/pl.yml
 - config/locales/pt-BR.yml
 - config/locales/ru.yml
@@ -202,8 +207,8 @@ files:
 - lib/apipie-rails.rb
 - lib/apipie/apipie_module.rb
 - lib/apipie/application.rb
-- lib/apipie/client/generator.rb
 - lib/apipie/configuration.rb
+- lib/apipie/core_ext/route.rb
 - lib/apipie/dsl_definition.rb
 - lib/apipie/error_description.rb
 - lib/apipie/errors.rb
@@ -218,10 +223,15 @@ files:
 - lib/apipie/param_description.rb
 - lib/apipie/railtie.rb
 - lib/apipie/resource_description.rb
+- lib/apipie/response_description.rb
+- lib/apipie/response_description_adapter.rb
 - lib/apipie/routes_formatter.rb
 - lib/apipie/routing.rb
+- lib/apipie/rspec/response_validation_helper.rb
 - lib/apipie/see_description.rb
 - lib/apipie/static_dispatcher.rb
+- lib/apipie/swagger_generator.rb
+- lib/apipie/tag_list_description.rb
 - lib/apipie/validator.rb
 - lib/apipie/version.rb
 - lib/generators/apipie/install/README
@@ -237,6 +247,8 @@ files:
 - spec/controllers/api/v2/nested/resources_controller_spec.rb
 - spec/controllers/apipies_controller_spec.rb
 - spec/controllers/concerns_controller_spec.rb
+- spec/controllers/extended_controller_spec.rb
+- spec/controllers/memes_controller_spec.rb
 - spec/controllers/users_controller_spec.rb
 - spec/dummy/Rakefile
 - spec/dummy/app/controllers/api/base_controller.rb
@@ -247,13 +259,27 @@ files:
 - spec/dummy/app/controllers/api/v2/nested/architectures_controller.rb
 - spec/dummy/app/controllers/api/v2/nested/resources_controller.rb
 - spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/concerns/extending_concern.rb
 - spec/dummy/app/controllers/concerns/sample_controller.rb
 - spec/dummy/app/controllers/concerns_controller.rb
+- spec/dummy/app/controllers/extended_controller.rb
 - spec/dummy/app/controllers/files_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
+- spec/dummy/app/controllers/pets_using_self_describing_classes_controller.rb
+- spec/dummy/app/controllers/tagged_cats_controller.rb
+- 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/views/layouts/application.html.erb
+- spec/dummy/components/test_engine/Gemfile
+- spec/dummy/components/test_engine/app/controllers/test_engine/application_controller.rb
+- spec/dummy/components/test_engine/app/controllers/test_engine/memes_controller.rb
+- spec/dummy/components/test_engine/config/routes.rb
+- spec/dummy/components/test_engine/db/.gitkeep
+- spec/dummy/components/test_engine/lib/test_engine.rb
+- spec/dummy/components/test_engine/test_engine.gemspec
 - spec/dummy/config.ru
 - spec/dummy/config/application.rb
 - spec/dummy/config/boot.rb
@@ -283,11 +309,16 @@ files:
 - spec/lib/extractor/extractor_spec.rb
 - spec/lib/extractor/middleware_spec.rb
 - spec/lib/extractor/writer_spec.rb
+- spec/lib/file_handler_spec.rb
 - spec/lib/method_description_spec.rb
 - spec/lib/param_description_spec.rb
 - spec/lib/param_group_spec.rb
 - spec/lib/rake_spec.rb
 - spec/lib/resource_description_spec.rb
+- spec/lib/swagger/openapi_2_0_schema.json
+- spec/lib/swagger/rake_swagger_spec.rb
+- spec/lib/swagger/response_validation_spec.rb
+- spec/lib/swagger/swagger_dsl_spec.rb
 - spec/lib/validator_spec.rb
 - spec/lib/validators/array_validator_spec.rb
 - spec/spec_helper.rb
@@ -303,7 +334,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -311,7 +342,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.7.10
 signing_key: 
 specification_version: 4
 summary: Rails REST API documentation tool
@@ -321,6 +352,8 @@ test_files:
 - spec/controllers/api/v2/nested/resources_controller_spec.rb
 - spec/controllers/apipies_controller_spec.rb
 - spec/controllers/concerns_controller_spec.rb
+- spec/controllers/extended_controller_spec.rb
+- spec/controllers/memes_controller_spec.rb
 - spec/controllers/users_controller_spec.rb
 - spec/dummy/Rakefile
 - spec/dummy/app/controllers/api/base_controller.rb
@@ -331,13 +364,27 @@ test_files:
 - spec/dummy/app/controllers/api/v2/nested/architectures_controller.rb
 - spec/dummy/app/controllers/api/v2/nested/resources_controller.rb
 - spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/concerns/extending_concern.rb
 - spec/dummy/app/controllers/concerns/sample_controller.rb
 - spec/dummy/app/controllers/concerns_controller.rb
+- spec/dummy/app/controllers/extended_controller.rb
 - spec/dummy/app/controllers/files_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
+- spec/dummy/app/controllers/pets_using_self_describing_classes_controller.rb
+- spec/dummy/app/controllers/tagged_cats_controller.rb
+- 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/views/layouts/application.html.erb
+- spec/dummy/components/test_engine/Gemfile
+- spec/dummy/components/test_engine/app/controllers/test_engine/application_controller.rb
+- spec/dummy/components/test_engine/app/controllers/test_engine/memes_controller.rb
+- spec/dummy/components/test_engine/config/routes.rb
+- spec/dummy/components/test_engine/db/.gitkeep
+- spec/dummy/components/test_engine/lib/test_engine.rb
+- spec/dummy/components/test_engine/test_engine.gemspec
 - spec/dummy/config.ru
 - spec/dummy/config/application.rb
 - spec/dummy/config/boot.rb
@@ -367,11 +414,16 @@ test_files:
 - spec/lib/extractor/extractor_spec.rb
 - spec/lib/extractor/middleware_spec.rb
 - spec/lib/extractor/writer_spec.rb
+- spec/lib/file_handler_spec.rb
 - spec/lib/method_description_spec.rb
 - spec/lib/param_description_spec.rb
 - spec/lib/param_group_spec.rb
 - spec/lib/rake_spec.rb
 - spec/lib/resource_description_spec.rb
+- spec/lib/swagger/openapi_2_0_schema.json
+- spec/lib/swagger/rake_swagger_spec.rb
+- spec/lib/swagger/response_validation_spec.rb
+- spec/lib/swagger/swagger_dsl_spec.rb
 - spec/lib/validator_spec.rb
 - spec/lib/validators/array_validator_spec.rb
 - spec/spec_helper.rb

data/Gemfile

@@ -1,7 +0,0 @@
-source "https://rubygems.org"
-
-gemspec
-
-# load local gemfile
-local_gemfile = File.join(File.dirname(__FILE__), 'Gemfile.local')
-self.instance_eval(Bundler.read_file(local_gemfile)) if File.exist?(local_gemfile)

data/Gemfile.rails32

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-gemspec
-
-gem 'rails', '~> 3.2.0'
-gem 'test-unit', '~> 3.0'

data/Gemfile.rails40

@@ -1,5 +0,0 @@
-source "https://rubygems.org"
-
-gemspec
-
-gem 'rails', '~> 4.0.0'

data/lib/apipie/client/generator.rb

@@ -1,135 +0,0 @@
-#!/bin/env ruby
-# -*- coding: utf-8 -*-
-require 'rubygems'
-require 'thor'
-require 'thor/group'
-require 'fileutils'
-require 'active_support/inflector'
-require 'apipie/client/base'
-
-module Apipie
-  module Client
-
-    class Generator < Thor::Group
-      include Thor::Actions
-
-      # Define arguments and options
-      argument :name
-      argument :subject
-      argument :suffix
-      argument :version
-
-      attr_reader :doc, :resource, :resource_key
-
-      def initialize(*args)
-        super
-        @doc = Apipie.to_json(version)[:docs]
-      end
-
-      def self.source_root
-        File.expand_path("../template", __FILE__)
-      end
-
-      def self.destination_root(name, suffix)
-        File.join(FileUtils.pwd, "#{name}#{suffix}")
-      end
-
-      def self.start(client_name, subject = :all, suffix = '_client', version = nil)
-        name = client_name.parameterize.underscore
-        suffix = suffix.parameterize.underscore
-        super([name, subject, suffix, version], :destination_root => destination_root(name, suffix))
-      end
-
-      def all?
-        subject == :all
-      end
-
-      def generate_cli
-        full_name = "#{name}#{suffix}"
-        template("README.tt", "README")
-        template("Gemfile.tt", "Gemfile")
-        template("Rakefile.tt", "Rakefile")
-        template("a_name.gemspec.tt", "#{full_name}.gemspec")
-        template("lib/a_name.rb.tt", "lib/#{full_name}.rb")
-        template("lib/a_name/version.rb.tt", "lib/#{full_name}/version.rb")
-        create_file "lib/#{full_name}/documentation.json", JSON.dump(Apipie.to_json)
-        copy_file "lib/a_name/config.yml", "lib/#{full_name}/config.yml"
-        if all?
-          template("bin/bin.rb.tt", "bin/#{full_name}")
-          chmod("bin/#{full_name}", 0755)
-        end
-        doc[:resources].each do |key, resource|
-          @resource_key, @resource = key, resource
-          if all?
-            template("lib/a_name/commands/cli.rb.tt", "lib/#{full_name}/commands/#{resource_name}.thor")
-          end
-          template("lib/a_name/resources/resource.rb.tt", "lib/#{full_name}/resources/#{resource_name}.rb")
-        end
-      end
-
-      protected
-
-      def camelizer(string)
-        string = string.sub(/^[a-z\d]*/) { $&.capitalize }
-        string.gsub(/(?:_|(\/))([a-z\d]*)/i) { "#{$2.capitalize}" }
-      end
-
-      def class_base
-        @class_base ||= camelizer(name)
-      end
-
-      def class_suffix
-        @class_suffix ||= camelizer(suffix)
-      end
-
-      def plaintext(text)
-        text.gsub(/<.*?>/, '').gsub("\n", ' ').strip
-      end
-
-      # Resource related helper methods:
-
-      def resource_name
-        resource[:name].gsub(/\s/, "_").downcase.singularize
-      end
-
-      def api(method)
-        method[:apis].first
-      end
-
-      def params_in_path(method)
-        api(method)[:api_url].scan(/:([^\/]*)/).map(&:first)
-      end
-
-      def client_args(method)
-        params_in_path(method).dup
-      end
-
-      def substituted_url(method)
-        params_in_path(method).reduce(api(method)[:api_url]) { |u, p| u.sub(":#{p}", "\#{#{p}}") }
-      end
-
-      def transformation_hash(method)
-        method[:params].find_all { |p| p[:expected_type] == "hash" && !p[:params].nil? }.reduce({ }) do |h, p|
-          h.update(p[:name] => p[:params].map { |pp| pp[:name] })
-        end
-      end
-
-      def validation(method)
-        stringify = lambda do |object|
-          case object
-            when Hash
-              clone = object.dup
-              object.keys.each { |key| clone[key.to_s] = stringify[clone.delete(key)] }
-              clone
-            when Array
-              object.map { |value| stringify[value] }
-            else
-              object
-          end
-        end
-        Apipie::Client::Base.construct_validation_hash(stringify[method])
-      end
-    end
-
-  end
-end