apipie-rails 0.5.16 → 0.5.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76693e27a28b80ae01788b2e561edf21c696281dfc2e4136849dfbc4c4f32c15
-  data.tar.gz: 7143177bc11ccf92dec72f636683a46561ac05eaf5e788a1f3184028a6ed7dfe
+  metadata.gz: 855ada05457368ea7521d46865242c73a15c33a33546d7b0dac1d2b90d779c70
+  data.tar.gz: 0cc30d4f4a38a476cab6ed92b6a4a00c45bd2036c8b35fb8373fbb215fb2ea80
 SHA512:
-  metadata.gz: 2d3e61a2f83762bbdcd2d90393f14a617ba0dac25f0a7367d20faa36f7d2829577c34db65ab2fe7902ee133b080030fe7460cea2b56e167b772a12d86a9aef4c
-  data.tar.gz: a2dec8a9cadfbf5ed44df8868c23af5ed8de9eff3b349222a2a829ee09773725e6dabbd1af6f155a1d1800a1636284f2db37f683c3f30b70dfa6442a71f77972
+  metadata.gz: 9b0ba79aee65ed21249fa35336166783697719fabc74831816513ea1d0b91162bde342b51fad08121ea38c27f5015bbf196ac524049dcbbc8635dd0a57f13cff
+  data.tar.gz: 0f9f593ee579dba0baf16175e8c9d916dd370eba6a5c37cee4df2a92dea1efe0ea936b2444597274dd327244063000bb3a9cff454413956cd98bd27c5652afc6

data/.travis.yml

@@ -16,6 +16,8 @@ gemfile:
   - Gemfile.rails60 # Min ruby 2.5.0
 matrix:
   exclude:
+    - rvm: 2.5.3
+      gemfile: Gemfile.rails42
     - rvm: 2.6.0
       gemfile: Gemfile.rails42
     - rvm: 2.2.10

data/CHANGELOG.md

@@ -1,6 +1,13 @@
  Changelog
 ===========
 
+[v0.5.17](https://github.com/Apipie/apipie-rails/tree/v0.5.17) (2020-01-20)
+--------
+
+[Full Changelog](https://github.com/Apipie/apipie-rails/compare/v0.5.16...v0.5.17)
+
+- Allows update metadata for methods [\#667](https://github.com/Apipie/apipie-rails/pull/667) ([speckins](https://github.com/speckins))
+
 [v0.5.16](https://github.com/Apipie/apipie-rails/tree/v0.5.16) (2019-05-22)
 --------
 
@@ -208,7 +215,7 @@ v0.3.2
 v0.3.1
 ------
 
-* Support for ``api!`` keyword in concerns 
+* Support for ``api!`` keyword in concerns
   [#322](https://github.com/Apipie/apipie-rails/pull/322) [@iNecas][]
 * More explicit ordering of the static dispatcher middleware
   [#315](https://github.com/Apipie/apipie-rails/pull/315) [@iNecas][]

data/Gemfile.rails41

@@ -4,3 +4,4 @@ gemspec
 
 gem 'rails', '~> 4.1.0'
 gem 'mime-types', '~> 2.99.3'
+gem 'test_engine', path: 'spec/dummy/components/test_engine', group: :test

data/Gemfile.rails42

@@ -10,3 +10,5 @@ if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.1.0')
   gem 'nokogiri', '~> 1.6.8'
   gem 'rdoc', '~> 4.2.2'
 end
+
+gem 'test_engine', path: 'spec/dummy/components/test_engine', group: :test

data/Gemfile.rails50

@@ -6,3 +6,4 @@ gem 'rails', '~> 5.0.0'
 gem 'mime-types', '~> 2.99.3'
 gem 'rails-controller-testing'
 
+gem 'test_engine', path: 'spec/dummy/components/test_engine', group: :test

data/Gemfile.rails51

@@ -5,3 +5,5 @@ gemspec
 gem 'rails', '~> 5.1.0.rc1'
 gem 'mime-types', '~> 2.99.3'
 gem 'rails-controller-testing'
+
+gem 'test_engine', path: 'spec/dummy/components/test_engine', group: :test

data/Gemfile.rails60

@@ -10,3 +10,5 @@ gem 'rspec-core', git: 'https://github.com/rspec/rspec-core'
 gem 'rspec-mocks', git: 'https://github.com/rspec/rspec-mocks'
 gem 'rspec-support', git: 'https://github.com/rspec/rspec-support'
 gem 'rspec-expectations', git: 'https://github.com/rspec/rspec-expectations'
+
+gem 'test_engine', path: 'spec/dummy/components/test_engine', group: :test

data/lib/apipie-rails.rb

@@ -2,6 +2,8 @@ require 'i18n'
 require 'json'
 require 'active_support/hash_with_indifferent_access'
 
+require 'apipie/core_ext/route.rb'
+
 require "apipie/routing"
 require "apipie/markup"
 require "apipie/apipie_module"

data/lib/apipie/application.rb

@@ -29,7 +29,7 @@ module Apipie
       @controller_to_resource_id[controller] = resource_id
     end
 
-    def rails_routes(route_set = nil)
+    def rails_routes(route_set = nil, base_url = "")
       if route_set.nil? && @rails_routes
         return @rails_routes
       end
@@ -40,10 +40,13 @@ module Apipie
       flatten_routes = []
 
       route_set.routes.each do |route|
-        if route.app.respond_to?(:routes) && route.app.routes.is_a?(ActionDispatch::Routing::RouteSet)
-          # recursively go though the moutned engines
-          flatten_routes.concat(rails_routes(route.app.routes))
+        # This is a hack to workaround a bug in apipie with Rails 4.2.5.1 or newer. See https://github.com/Apipie/apipie-rails/issues/415
+        route_app = Rails::VERSION::STRING.to_f >= 4.2 ? route.app.app : route.app
+        if route_app.respond_to?(:routes) && route_app.routes.is_a?(ActionDispatch::Routing::RouteSet)
+          # recursively go though the mounted engines
+          flatten_routes.concat(rails_routes(route_app.routes, File.join(base_url, route.path.spec.to_s)))
         else
+          route.base_url = base_url
           flatten_routes << route
         end
       end

data/lib/apipie/core_ext/route.rb

@@ -0,0 +1,9 @@
+module Apipie
+  module BaseUrlExtension
+    attr_accessor :base_url
+  end
+end
+
+class ActionDispatch::Journey::Route
+  include Apipie::BaseUrlExtension
+end

data/lib/apipie/dsl_definition.rb

@@ -488,19 +488,33 @@ module Apipie
       #         param_names.each { |p| param p, String }
       #       end
       #      end
-      def apipie_update_params(methods, *args, &block)
+      def _apipie_update_params(method_desc, dsl_data)
+        params_ordered = dsl_data[:params].map do |args|
+          Apipie::ParamDescription.from_dsl_data(method_desc, args)
+        end
+        ParamDescription.merge(method_desc.params_ordered_self, params_ordered)
+      end
+
+      def _apipie_update_meta(method_desc, dsl_data)
+        return unless dsl_data[:meta] && dsl_data[:meta].is_a?(Hash)
+
+        method_desc.metadata ||= {}
+        method_desc.metadata.merge!(dsl_data[:meta])
+      end
+
+      def apipie_update_methods(methods, *args, &block)
         methods.each do |method|
-          method_description = Apipie.get_method_description(self, method)
-          unless method_description
+          method_desc = Apipie.get_method_description(self, method)
+          unless method_desc
             raise "Could not find method description for #{self}##{method}. Was the method defined?"
           end
           dsl_data = _apipie_eval_dsl(*args, &block)
-          params_ordered = dsl_data[:params].map do |args|
-            Apipie::ParamDescription.from_dsl_data(method_description, args)
-          end
-          ParamDescription.merge(method_description.params_ordered_self, params_ordered)
+          _apipie_update_params(method_desc, dsl_data)
+          _apipie_update_meta(method_desc, dsl_data)
         end
       end
+      # backwards compatibility
+      alias_method :apipie_update_params, :apipie_update_methods
 
       def _apipie_concern_subst
         @_apipie_concern_subst ||= {:controller_path => self.controller_path,
@@ -550,7 +564,7 @@ module Apipie
           controller._apipie_define_validators(description)
         end
         _apipie_concern_update_api_blocks.each do |(methods, block)|
-          controller.apipie_update_params(methods, &block)
+          controller.apipie_update_methods(methods, &block)
         end
       end
 

data/lib/apipie/method_description.rb

@@ -17,7 +17,8 @@ module Apipie
 
     end
 
-    attr_reader :full_description, :method, :resource, :apis, :examples, :see, :formats, :metadata, :headers, :show
+    attr_reader :full_description, :method, :resource, :apis, :examples, :see, :formats, :headers, :show
+    attr_accessor :metadata
 
     def initialize(method, resource, dsl_data)
       @method = method.to_s

data/lib/apipie/routes_formatter.rb

@@ -16,7 +16,7 @@ module Apipie
     end
 
     def format_path(rails_route)
-      rails_route.path.spec.to_s.gsub('(.:format)', '')
+      File.join(rails_route.base_url, rails_route.path.spec.to_s.gsub('(.:format)', ''))
     end
 
     def format_verb(rails_route)

data/lib/apipie/swagger_generator.rb

@@ -651,14 +651,15 @@ module Apipie
 
     def add_headers_from_hash(swagger_params_array, headers)
       swagger_headers = headers.map do |header|
-        {
+        header_hash = {
           name: header[:name],
           in: 'header',
           required: header[:options][:required],
           description: header[:description],
           type:  header[:options][:type] || 'string'
         }
-
+        header_hash[:default] = header[:options][:default] if header[:options][:default]
+        header_hash
       end
       swagger_params_array.push(*swagger_headers)
     end

data/lib/apipie/validator.rb

@@ -129,6 +129,8 @@ module Apipie
           'array'
         elsif @type.ancestors.include? Numeric
           'numeric'
+        elsif @type.ancestors.include? File
+          'file'
         else
           'string'
         end

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = '0.5.16'
+  VERSION = '0.5.17'
 end

data/spec/controllers/extended_controller_spec.rb

@@ -7,5 +7,8 @@ describe ExtendedController do
     user_param = Apipie["extended#create"].params[:user]
     expect(user_param.validator.params_ordered.map(&:name)).to eq [:name, :password, :from_concern]
   end
-end
 
+  it 'should include updated metadata' do
+    expect(Apipie['extended#create'].metadata).to eq metadata: 'data'
+  end
+end

data/spec/controllers/memes_controller_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe TestEngine::MemesController do
+
+  describe "#index" do
+    it "should have the full mounted path of engine" do
+      Apipie.routes_for_action(TestEngine::MemesController, :index, {}).first[:path].should eq("/test/memes")
+    end
+  end
+end

data/spec/controllers/users_controller_spec.rb

@@ -488,12 +488,24 @@ describe UsersController do
           }
         end
 
+        let(:expected_header_with_default) do
+          {
+            name: :HeaderNameWithDefaultValue,
+            description: 'Header with default value',
+            options: {
+              required: true,
+              default: 'default value'
+            }
+          }
+        end
+
         it 'contains all headers description in method doc' do
           headers = Apipie.get_method_description(UsersController, :action_with_headers).headers
           expect(headers).to be_an(Array)
 
           compare_hashes headers[0], expected_required_header
           compare_hashes headers[1], expected_optional_header
+          compare_hashes headers[2], expected_header_with_default
         end
       end
 

data/spec/dummy/app/controllers/concerns/extending_concern.rb

@@ -6,6 +6,7 @@ module Concerns
       param :user, Hash do
         param :from_concern, String, :desc => 'param from concern', :allow_nil => false
       end
+      meta metadata: 'data'
     end
   end
 end

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

@@ -292,6 +292,7 @@ class UsersController < ApplicationController
   api :GET, '/users/action_with_headers'
   header :RequredHeaderName, 'Required header description', required: true
   header :OptionalHeaderName, 'Optional header description', required: false, type: 'string'
+  header :HeaderNameWithDefaultValue, 'Header with default value', required: true, default: 'default value'
   def action_with_headers
   end
 end

data/spec/dummy/components/test_engine/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Declare your gem's dependencies in test_engine.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec

data/spec/dummy/components/test_engine/app/controllers/test_engine/application_controller.rb

@@ -0,0 +1,4 @@
+module TestEngine
+  class ApplicationController < ActionController::Base
+  end
+end

data/spec/dummy/components/test_engine/app/controllers/test_engine/memes_controller.rb

@@ -0,0 +1,37 @@
+module TestEngine
+  class MemesController < TestEngine::ApplicationController
+    api! 'Returns a list of all good memes on Twitter'
+    param :api_token, String, required: true, desc: 'Your Twitter API token'
+    def index
+      render json: []
+    end
+
+    api! 'Shows info about a particular meme on Twitter'
+    param :id, :number, required: true, desc: 'ID of the meme'
+    def show
+      render json: {id: params[:id]}
+    end
+
+    api! 'Create a new meme on Twitter'
+    param :api_token, String, required: true, desc: 'Your Twitter API token'
+    param :name, String, required: true, desc: 'Name of your meme'
+    param :src_url, String, required: true, desc: 'URL for your meme'
+    def create
+      render json: {name: params[:name], src_url: params[:src_url]}, status: :created
+    end
+
+    api! 'Update a meme on Twitter'
+    param :api_token, String, required: true, desc: 'Your Twitter API token'
+    param :name, String, required: false, desc: 'Name of your meme'
+    param :src_url, String, required: false, desc: 'URL for your meme'
+    def update
+      render json: {name: params[:name], src_url: params[:src_url]}
+    end
+
+    api! 'Delete a meme on Twitter'
+    param :id, :number, required: true, desc: 'ID of the meme'
+    def destroy
+      head :ok
+    end
+  end
+end

data/spec/dummy/components/test_engine/config/routes.rb

@@ -0,0 +1,3 @@
+TestEngine::Engine.routes.draw do
+  resources :memes, only: [:index, :show, :create, :update, :destroy]
+end

data/spec/dummy/components/test_engine/lib/test_engine.rb

@@ -0,0 +1,7 @@
+require 'apipie-rails'
+
+module TestEngine
+  class Engine < ::Rails::Engine
+    isolate_namespace TestEngine
+  end
+end

data/spec/dummy/components/test_engine/test_engine.gemspec

@@ -0,0 +1,11 @@
+$:.push File.expand_path('../lib', __FILE__)
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = 'test_engine'
+  s.version     = '0.0.1'
+  s.summary     = 'Test Engine'
+  s.authors     = 'Test Author'
+
+  s.files = Dir['{app,config,db,lib}/**/*']
+end

data/spec/dummy/config/application.rb

@@ -8,6 +8,7 @@ require "action_mailer/railtie"
 
 Bundler.require
 require "apipie-rails"
+require "test_engine"
 
 module Dummy
   class Application < Rails::Application

data/spec/dummy/config/routes.rb

@@ -1,5 +1,7 @@
 Dummy::Application.routes.draw do
 
+  mount TestEngine::Engine => '/test'
+
   scope ENV['RAILS_RELATIVE_URL_ROOT'] || '/' do
 
     scope '/api' do

data/spec/spec_helper.rb

@@ -8,6 +8,7 @@ require File.expand_path("../dummy/config/environment", __FILE__)
 require 'rspec/rails'
 
 require 'apipie-rails'
+require 'test_engine'
 
 module Rails4Compatibility
   module Testing

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.16
+  version: 0.5.17
 platform: ruby
 authors:
 - Pavel Pokorny
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-22 00:00:00.000000000 Z
+date: 2020-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -208,6 +208,7 @@ files:
 - lib/apipie/apipie_module.rb
 - lib/apipie/application.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
@@ -247,6 +248,7 @@ files:
 - 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
@@ -271,6 +273,13 @@ files:
 - 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
@@ -333,7 +342,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.10
 signing_key: 
 specification_version: 4
 summary: Rails REST API documentation tool
@@ -344,6 +353,7 @@ test_files:
 - 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
@@ -368,6 +378,13 @@ test_files:
 - 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