porta/app/controllers/admin/api_docs/base_controller.rb at 31ac83d6ee5e9ee1a61f1be8976381ba4d38df64 · 3scale/porta · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
# frozen_string_literal: true

class Admin::ApiDocs::BaseController < FrontendController
  before_action :deny_on_premises_for_master
  before_action :authorize_api_docs
  before_action :find_api_docs, only: %i[show preview toggle_visible edit update destroy]
  before_action :new_service_id_permitted, only: %i[create update]
  helper_method :current_scope

  def index
    @presenter = Provider::Admin::ApiDocsIndexPresenter.new(scope: current_scope,
                                                            user: current_user,
                                                            params: params)
  end

  def new
    @api_docs_service = api_docs_services.new
  end

  def create
    @api_docs_service = api_docs_services.new(api_docs_params(:system_name))
    if @api_docs_service.save
      redirect_to preview_admin_api_docs_service_path(@api_docs_service), success: t('admin.api_docs.create.success')
    else
      render :new
    end
  end

  # Fetching the spec JSON via /admin/api_docs/services/<ID>.json
  def show
    specification = api_docs_service.specification
    if specification.swagger_2_0?
      # TODO: this is temporary until we get swagger-ui to load swagger-2.0
      response.headers['X-Frame-Options'] = 'SAMEORIGIN'
      json = JSON.pretty_generate specification.as_json
    else
      translator = ThreeScale::Swagger::Translator.translate! @api_docs_service.body
      json = translator.as_json
    end

    respond_to do | format |
      format.json { render json: json }
    end
  end

  # Render the spec preview page, e.g. /apiconfig/services/<svc_id>/api_docs/<api_doc_id>/preview
  def preview
    if api_docs_service.specification.swagger?
      respond_to do |format|
        format.html { render 'swagger' }
        format.json { render json: swagger_spec }
      end
    else
      @host = current_account.external_domain
      @resource = api_docs_service.system_name
      @spec = ApiDocs::Service.spec_for api_docs_service
      render 'active_docs'
    end
  end

  def toggle_visible
    api_docs_service.toggle! :published

    flash[:success] = t("admin.api_docs.base.toggle_visible.#{api_docs_service.published? ? :visible : :hidden}", name: api_docs_service.name)

    respond_to do |format|
      format.html { redirect_to preview_admin_api_docs_service_path(api_docs_service) }
    end
  end

  def edit; end

  def update
    respond_to do |format|
      if api_docs_service.update(api_docs_params)
        msg = t('admin.api_docs.update.success')
        format.html { redirect_to preview_admin_api_docs_service_path(api_docs_service), success: msg }
        format.js do
          flash.now[:success] = msg
          render 'shared/flash_alerts'
        end
      else
        format.html { render :edit }
        format.js {}
      end
    end
  end

  def destroy
    api_docs_service.destroy

    flash[:success] = t('admin.api_docs.destroy.success')

    respond_to do |format|
      format.html { redirect_to admin_api_docs_services_path }
    end
  end

  private

  attr_reader :api_docs_service

  def current_scope
    raise NoMethodError, "#{__method__} not implemented in #{self.class}"
  end

  def api_docs_params(*extra_params)
    permit_params = %i[name body description published skip_swagger_validations service_id] + extra_params
    params.require(:api_docs_service).permit(*permit_params)
  end

  def api_docs_services
    current_scope.api_docs_services
  end

  def accessible_api_docs_services
    api_docs_services.permitted_for(current_user)
  end

  def find_api_docs
    @api_docs_service = accessible_api_docs_services.find_by_id_or_system_name!(params[:id])
  end

  def new_service_id_permitted
    service_id = api_docs_params[:service_id]
    service_id.blank? || current_user.accessible_services.find(service_id)
  end

  def swagger_spec
    specification = api_docs_service.specification
    specification.swagger_2_0? ? specification : resource_listing
  end

  def resource_listing
    {
      swaggerVersion: '1.2',
      apis: [
        {
          description: api_docs_service.description || api_docs_service.name,
          path: "#{admin_api_docs_service_path(api_docs_service.system_name)}.{format}"
        }
      ],
      basePath: "#{request.protocol}#{request.host_with_port}"
    }
  end

  def authorize_api_docs
    authorize! :manage, :plans
  end
end