apipie-rails-jq 1.4.3.pre.beta.pre.jq.1

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Default: run specs.'
+task :default => :spec
+

data/apipie-rails.gemspec

@@ -0,0 +1,44 @@
+# -*- encoding: utf-8 -*-
+
+$:.push File.expand_path('lib', __dir__)
+require "apipie/version"
+
+Gem::Specification.new do |s|
+  s.name        = "apipie-rails-jq"
+  s.version     = Apipie::VERSION
+  s.authors     = ["Pavel Pokorny","Ivan Necas"]
+  s.email       = ["pajkycz@gmail.com", "inecas@redhat.com"]
+  s.homepage    = "https://github.com/Apipie/apipie-rails"
+  s.summary     = %q{Rails REST API documentation tool}
+  s.description = %q{Rails REST API documentation tool}
+  s.required_ruby_version = '>= 2.6.0'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.metadata = {
+    "bug_tracker_uri" => "https://github.com/Apipie/apipie-rails/issues",
+    "changelog_uri" => "https://github.com/Apipie/apipie-rails/blob/master/CHANGELOG.md",
+    "source_code_uri" => "https://github.com/Apipie/apipie-rails"
+  }
+
+  s.add_dependency "actionpack", ">= 5.0"
+  s.add_dependency "activesupport", ">= 5.0"
+
+  # Optional dependencies
+  s.add_development_dependency "maruku"   # for Markdown support
+  s.add_development_dependency "RedCloth" # for Textile support
+
+  # Dev/tests only dependencies
+  s.add_development_dependency "json-schema", "~> 2.8"
+  s.add_development_dependency "rspec-rails", "~> 3.0"
+  s.add_development_dependency "rake"
+  s.add_development_dependency 'rubocop_challenger'
+  s.add_development_dependency 'rubocop-rails'
+  s.add_development_dependency 'rubocop-rspec'
+  s.add_development_dependency 'rubocop-performance'
+  s.add_development_dependency 'rubocop-rspec_rails' if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.7")
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "sqlite3"
+end

data/app/controllers/apipie/apipies_controller.rb

@@ -0,0 +1,184 @@
+module Apipie
+  class ApipiesController < ActionController::Base
+    include ActionView::Context
+    include ApipieHelper
+
+    layout Apipie.configuration.layout
+
+    around_action :set_script_name
+    before_action :authenticate
+
+    def authenticate
+      if Apipie.configuration.authenticate
+        instance_eval(&Apipie.configuration.authenticate)
+      end
+    end
+
+
+    def index
+      params[:version] ||= Apipie.configuration.default_version
+
+      get_format
+
+      if params[:type].to_s == 'swagger' && params[:format].to_s == 'json'
+        head :forbidden and return if Apipie.configuration.authorize
+        should_render_swagger = true
+      end
+
+      respond_to do |format|
+
+        if Apipie.configuration.use_cache?
+          render_from_cache
+          return
+        end
+
+        @language = get_language
+
+        Apipie.load_documentation if Apipie.configuration.reload_controllers? || !Rails.application.config.eager_load
+
+        I18n.locale = @language
+
+        if should_render_swagger
+          prev_warning_value = Apipie.configuration.generator.swagger.suppress_warnings
+          begin
+            Apipie.configuration.generator.swagger.suppress_warnings = true
+            @doc = Apipie.to_swagger_json(params[:version], params[:resource], params[:method], @language)
+          ensure
+            Apipie.configuration.generator.swagger.suppress_warnings = prev_warning_value
+          end
+        else
+          @doc = Apipie.to_json(params[:version], params[:resource], params[:method], @language)
+          @doc = authorized_doc
+        end
+
+        format.json do
+          if @doc
+            render :json => @doc
+          else
+            head :not_found
+          end
+        end
+
+        format.html do
+          unless @doc
+            render 'apipie_404', :status => 404
+            return
+          end
+
+          @versions = Apipie.available_versions
+          @doc = @doc[:docs]
+          @doc[:link_extension] = (@language ? ".#{@language}" : '')+Apipie.configuration.link_extension
+          if @doc[:resources].blank?
+            render "getting_started" and return
+          end
+          @resource = @doc[:resources].first if params[:resource].present?
+          @method = @resource[:methods].first if params[:method].present?
+          @languages = Apipie.configuration.languages
+
+          if @resource && @method
+            render 'method'
+          elsif @resource
+            render 'resource'
+          elsif params[:resource].present? || params[:method].present?
+            render 'apipie_404', :status => 404
+          else
+            render 'index'
+          end
+        end
+      end
+    end
+
+    def apipie_checksum
+    end
+
+    private
+    helper_method :heading
+
+    def get_language
+      return nil unless Apipie.configuration.translate
+      lang = Apipie.configuration.default_locale
+      [:resource, :method, :version].each do |par|
+        next unless params[par]
+        splitted = params[par].split('.')
+        if splitted.length > 1 && (Apipie.configuration.languages.include?(splitted.last) || Apipie.configuration.default_locale == splitted.last)
+          lang = splitted.last
+          params[par].sub!(".#{lang}", '')
+        end
+      end
+      lang
+    end
+
+    def authorized_doc
+      return if @doc.nil?
+      return @doc unless Apipie.configuration.authorize
+
+      new_doc = { :docs => @doc[:docs].clone }
+
+      new_doc[:docs][:resources] = if @doc[:docs][:resources].kind_of?(Array)
+        @doc[:docs][:resources].select do |resource|
+          authorize_resource(resource)
+        end
+      else
+        @doc[:docs][:resources].select do |_resource_id, resource|
+          authorize_resource(resource)
+        end
+      end
+
+      new_doc
+    end
+
+    def authorize_resource resource
+      if instance_exec(resource[:id], nil, resource, &Apipie.configuration.authorize)
+        resource[:methods] = resource[:methods].select do |m|
+          instance_exec(resource[:id], m[:name], m, &Apipie.configuration.authorize)
+        end
+        true
+      else
+        false
+      end
+    end
+
+    def get_format
+      [:resource, :method, :version].each do |par|
+        next unless params[par]
+        [:html, :json].each do |format|
+          extension = ".#{format}"
+          if params[par].include?(extension)
+            params[par] = params[par].sub(extension, '')
+            params[:format] = format
+          end
+        end
+      end
+      request.format = params[:format] if params[:format]
+    end
+
+    def render_from_cache
+      path = Apipie.configuration.doc_base_url.dup
+      path << "/" << params[:version] if params[:version].present?
+      path << "/" << params[:resource] if params[:resource].present?
+      path << "/" << params[:method] if params[:method].present?
+      # Sanitize path against directory traversal attacks (e.g. ../../foo)
+      # by turning path into an absolute path before appending it to the cache dir
+      path = File.expand_path("#{path}.#{request.format.symbol}", '/')
+
+      cache_file = File.join(Apipie.configuration.cache_dir, path)
+      if File.exist?(cache_file)
+        content_type = case params[:format]
+                       when "json" then "application/json"
+                       else "text/html"
+                       end
+        send_file cache_file, :type => content_type, :disposition => "inline"
+      else
+        Rails.logger.error("API doc cache not found for '#{path}'. Perhaps you have forgot to run `rake apipie:cache`")
+        head :not_found
+      end
+    end
+
+    def set_script_name
+      Apipie.request_script_name = request.env["SCRIPT_NAME"]
+      yield
+    ensure
+      Apipie.request_script_name = nil
+    end
+  end
+end

data/app/helpers/apipie_helper.rb

@@ -0,0 +1,10 @@
+module ApipieHelper
+  include ActionView::Helpers::TagHelper
+
+  def heading(title, level = 1)
+    content_tag("h#{level}") do
+      title
+    end
+  end
+
+end

data/app/public/apipie/javascripts/apipie.js

@@ -0,0 +1,6 @@
+$(document).ready(function() {
+  if (typeof prettyPrint == 'function') {
+    $('pre.ruby').addClass('prettyprint lang-rb');
+    prettyPrint();
+  }
+});

data/app/public/apipie/javascripts/bundled/bootstrap-collapse.js

@@ -0,0 +1,167 @@
+/* =============================================================
+ * bootstrap-collapse.js v2.3.2
+ * http://getbootstrap.com/2.3.2/javascript.html#collapse
+ * =============================================================
+ * Copyright 2013 Twitter, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============================================================ */
+
+
+!function ($) {
+
+  "use strict"; // jshint ;_;
+
+
+ /* COLLAPSE PUBLIC CLASS DEFINITION
+  * ================================ */
+
+  var Collapse = function (element, options) {
+    this.$element = $(element)
+    this.options = $.extend({}, $.fn.collapse.defaults, options)
+
+    if (this.options.parent) {
+      this.$parent = $(this.options.parent)
+    }
+
+    this.options.toggle && this.toggle()
+  }
+
+  Collapse.prototype = {
+
+    constructor: Collapse
+
+  , dimension: function () {
+      var hasWidth = this.$element.hasClass('width')
+      return hasWidth ? 'width' : 'height'
+    }
+
+  , show: function () {
+      var dimension
+        , scroll
+        , actives
+        , hasData
+
+      if (this.transitioning || this.$element.hasClass('in')) return
+
+      dimension = this.dimension()
+      scroll = $.camelCase(['scroll', dimension].join('-'))
+      actives = this.$parent && this.$parent.find('> .accordion-group > .in')
+
+      if (actives && actives.length) {
+        hasData = actives.data('collapse')
+        if (hasData && hasData.transitioning) return
+        actives.collapse('hide')
+        hasData || actives.data('collapse', null)
+      }
+
+      this.$element[dimension](0)
+      this.transition('addClass', $.Event('show'), 'shown')
+      $.support.transition && this.$element[dimension](this.$element[0][scroll])
+    }
+
+  , hide: function () {
+      var dimension
+      if (this.transitioning || !this.$element.hasClass('in')) return
+      dimension = this.dimension()
+      this.reset(this.$element[dimension]())
+      this.transition('removeClass', $.Event('hide'), 'hidden')
+      this.$element[dimension](0)
+    }
+
+  , reset: function (size) {
+      var dimension = this.dimension()
+
+      this.$element
+        .removeClass('collapse')
+        [dimension](size || 'auto')
+        [0].offsetWidth
+
+      this.$element[size !== null ? 'addClass' : 'removeClass']('collapse')
+
+      return this
+    }
+
+  , transition: function (method, startEvent, completeEvent) {
+      var that = this
+        , complete = function () {
+            if (startEvent.type == 'show') that.reset()
+            that.transitioning = 0
+            that.$element.trigger(completeEvent)
+          }
+
+      this.$element.trigger(startEvent)
+
+      if (startEvent.isDefaultPrevented()) return
+
+      this.transitioning = 1
+
+      this.$element[method]('in')
+
+      $.support.transition && this.$element.hasClass('collapse') ?
+        this.$element.one($.support.transition.end, complete) :
+        complete()
+    }
+
+  , toggle: function () {
+      this[this.$element.hasClass('in') ? 'hide' : 'show']()
+    }
+
+  }
+
+
+ /* COLLAPSE PLUGIN DEFINITION
+  * ========================== */
+
+  var old = $.fn.collapse
+
+  $.fn.collapse = function (option) {
+    return this.each(function () {
+      var $this = $(this)
+        , data = $this.data('collapse')
+        , options = $.extend({}, $.fn.collapse.defaults, $this.data(), typeof option == 'object' && option)
+      if (!data) $this.data('collapse', (data = new Collapse(this, options)))
+      if (typeof option == 'string') data[option]()
+    })
+  }
+
+  $.fn.collapse.defaults = {
+    toggle: true
+  }
+
+  $.fn.collapse.Constructor = Collapse
+
+
+ /* COLLAPSE NO CONFLICT
+  * ==================== */
+
+  $.fn.collapse.noConflict = function () {
+    $.fn.collapse = old
+    return this
+  }
+
+
+ /* COLLAPSE DATA-API
+  * ================= */
+
+  $(document).on('click.collapse.data-api', '[data-toggle=collapse]', function (e) {
+    var $this = $(this), href
+      , target = $this.attr('data-target')
+        || e.preventDefault()
+        || (href = $this.attr('href')) && href.replace(/.*(?=#[^\s]+$)/, '') //strip for ie7
+      , option = $(target).data('collapse') ? 'toggle' : $this.data()
+    $this[$(target).hasClass('in') ? 'addClass' : 'removeClass']('collapsed')
+    $(target).collapse(option)
+  })
+
+}(window.jQuery);