BigW Consortium Gitlab

snippets.rb 5.31 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
module API
  # Snippets API
  class Snippets < Grape::API
    include PaginationParams

    before { authenticate! }

    resource :snippets do
      helpers do
        def snippets_for_current_user
11
          SnippetsFinder.new(current_user, author: current_user).execute
12 13 14
        end

        def public_snippets
15
          SnippetsFinder.new(current_user, visibility: Snippet::PUBLIC).execute
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
        end
      end

      desc 'Get a snippets list for authenticated user' do
        detail 'This feature was introduced in GitLab 8.15.'
        success Entities::PersonalSnippet
      end
      params do
        use :pagination
      end
      get do
        present paginate(snippets_for_current_user), with: Entities::PersonalSnippet
      end

      desc 'List all public snippets current_user has access to' do
        detail 'This feature was introduced in GitLab 8.15.'
        success Entities::PersonalSnippet
      end
      params do
        use :pagination
      end
      get 'public' do
        present paginate(public_snippets), with: Entities::PersonalSnippet
      end

      desc 'Get a single snippet' do
        detail 'This feature was introduced in GitLab 8.15.'
        success Entities::PersonalSnippet
      end
      params do
        requires :id, type: Integer, desc: 'The ID of a snippet'
      end
      get ':id' do
        snippet = snippets_for_current_user.find(params[:id])
        present snippet, with: Entities::PersonalSnippet
      end

      desc 'Create new snippet' do
        detail 'This feature was introduced in GitLab 8.15.'
        success Entities::PersonalSnippet
      end
      params do
        requires :title, type: String, desc: 'The title of a snippet'
        requires :file_name, type: String, desc: 'The name of a snippet file'
        requires :content, type: String, desc: 'The content of a snippet'
61
        optional :description, type: String, desc: 'The description of a snippet'
62 63 64 65
        optional :visibility, type: String,
                              values: Gitlab::VisibilityLevel.string_values,
                              default: 'internal',
                              desc: 'The visibility of the snippet'
66 67
      end
      post do
68
        attrs = declared_params(include_missing: false).merge(request: request, api: true)
69 70
        snippet = CreateSnippetService.new(nil, current_user, attrs).execute

71 72
        render_spam_error! if snippet.spam?

73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
        if snippet.persisted?
          present snippet, with: Entities::PersonalSnippet
        else
          render_validation_error!(snippet)
        end
      end

      desc 'Update an existing snippet' do
        detail 'This feature was introduced in GitLab 8.15.'
        success Entities::PersonalSnippet
      end
      params do
        requires :id, type: Integer, desc: 'The ID of a snippet'
        optional :title, type: String, desc: 'The title of a snippet'
        optional :file_name, type: String, desc: 'The name of a snippet file'
        optional :content, type: String, desc: 'The content of a snippet'
89
        optional :description, type: String, desc: 'The description of a snippet'
90 91 92 93
        optional :visibility, type: String,
                              values: Gitlab::VisibilityLevel.string_values,
                              desc: 'The visibility of the snippet'
        at_least_one_of :title, :file_name, :content, :visibility
94 95 96 97 98 99
      end
      put ':id' do
        snippet = snippets_for_current_user.find_by(id: params.delete(:id))
        return not_found!('Snippet') unless snippet
        authorize! :update_personal_snippet, snippet

100
        attrs = declared_params(include_missing: false).merge(request: request, api: true)
101 102

        UpdateSnippetService.new(nil, current_user, snippet, attrs).execute
103 104 105

        render_spam_error! if snippet.spam?

106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
        if snippet.persisted?
          present snippet, with: Entities::PersonalSnippet
        else
          render_validation_error!(snippet)
        end
      end

      desc 'Remove snippet' do
        detail 'This feature was introduced in GitLab 8.15.'
        success Entities::PersonalSnippet
      end
      params do
        requires :id, type: Integer, desc: 'The ID of a snippet'
      end
      delete ':id' do
        snippet = snippets_for_current_user.find_by(id: params.delete(:id))
        return not_found!('Snippet') unless snippet
123

124
        authorize! :destroy_personal_snippet, snippet
125

126
        destroy_conditionally!(snippet)
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
      end

      desc 'Get a raw snippet' do
        detail 'This feature was introduced in GitLab 8.15.'
      end
      params do
        requires :id, type: Integer, desc: 'The ID of a snippet'
      end
      get ":id/raw" do
        snippet = snippets_for_current_user.find_by(id: params.delete(:id))
        return not_found!('Snippet') unless snippet

        env['api.format'] = :txt
        content_type 'text/plain'
        present snippet.content
      end
143 144 145 146 147 148 149 150 151 152

      desc 'Get the user agent details for a snippet' do
        success Entities::UserAgentDetail
      end
      params do
        requires :id, type: Integer, desc: 'The ID of a snippet'
      end
      get ":id/user_agent_detail" do
        authenticated_as_admin!

153
        snippet = Snippet.find_by!(id: params[:id])
154 155 156 157 158

        return not_found!('UserAgentDetail') unless snippet.user_agent_detail

        present snippet.user_agent_detail, with: Entities::UserAgentDetail
      end
159 160 161
    end
  end
end