Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Document new Snippet creation API #720

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document new Snippet creation API #720

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions lib/gitlab/client/snippets.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,14 @@ def snippet(project, id)
# Creates a new snippet.
#
# @example
# Gitlab.create_snippet(42, { title: 'REST', file_name: 'api.rb', code: 'some code', visibility: 'public'})
# Gitlab.create_snippet(3, title: 'REST', description: 'A sample snippet', files: [ {content: 'Hello world', file_path: 'test.txt'} ], visibility: 'public')
#
# @param [Integer, String] project The ID or name of a project.
# @param [Hash] options A customizable set of options.
# @option options [String] :title (required) The title of a snippet.
# @option options [String] :file_name (required) The name of a snippet file.
# @option options [String] :code (required) The content of a snippet.
# @option options [String] :lifetime (optional) The expiration date of a snippet.
# @option options [String] :visibility (required) The visibility of a snippet
# @option options [String] :title The title of a snippet (*required*).
# @option options [String] :description The description of a snippet (_optional_).
# @option options [Array<Hash<String, String>>] :files Array of snippet files, each _Hash_ needs +content+ and +file_path+ keys (*required*)
# @option options [String] :visibility The visibility of a snippet (_optional_).
# @return [Gitlab::ObjectifiedHash] Information about created snippet.
def create_snippet(project, options = {})
post("/projects/#{url_encode project}/snippets", body: options)
Expand Down
27 changes: 26 additions & 1 deletion spec/fixtures/snippet.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,26 @@
{"id":1,"title":"Rails Console ActionMailer","file_name":"mailer_test.rb","author":{"id":1,"email":"[email protected]","name":"John Smith","blocked":false,"created_at":"2012-09-17T09:41:56Z"},"expires_at":"2012-09-24T00:00:00Z","updated_at":"2012-09-17T09:51:42Z","created_at":"2012-09-17T09:51:42Z"}
{
"id": 1,
"title": "Rails Console ActionMailer",
"description": "A sample snippet",
"file_name": "mailer_test.rb",
"files": [
{
"path": "mailer_test.rb",
"raw_url": "https://example.org/group/project/-/snippet/4/raw/main/mailer_test.rb"
},
{
"path": "2.rb",
"raw_url": "https://gitlab.com/gitlab-org/gitlab/-/snippets/4881934/raw/main/2.rb"
}
],
"author": {
"id": 1,
"email": "[email protected]",
"name": "John Smith",
"blocked": false,
"created_at": "2012-09-17T09:41:56Z"
},
"expires_at": "2012-09-24T00:00:00Z",
"updated_at": "2012-09-17T09:51:42Z",
"created_at": "2012-09-17T09:51:42Z"
}
8 changes: 5 additions & 3 deletions spec/gitlab/client/snippets_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,16 +38,18 @@
describe '.create_snippet' do
before do
stub_post('/projects/3/snippets', 'snippet')
@snippet = Gitlab.create_snippet(3, title: 'API', file_name: 'api.rb', code: 'code', visibility: 'public')
@body = { title: 'REST', description: 'A sample snippet', files: [{ content: 'Hello world', 'file_path': 'mailer_test.rb' }], visibility: 'public' }
@snippet = Gitlab.create_snippet(3, @body)
end

it 'gets the correct resource' do
body = { title: 'API', file_name: 'api.rb', code: 'code', visibility: 'public' }
expect(a_post('/projects/3/snippets').with(body: body)).to have_been_made
expect(a_post('/projects/3/snippets').with(body: @body)).to have_been_made
end

it 'returns information about a new snippet' do
expect(@snippet.file_name).to eq('mailer_test.rb')
expect(@snippet.files).to be_a(Array)
expect(@snippet.description).to eq('A sample snippet')
expect(@snippet.author.name).to eq('John Smith')
end
end
Expand Down