This repository has been archived by the owner on Dec 10, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 961
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #621 from alex-berger/feature/project-import-export
Project Import/Export API
- Loading branch information
Showing
5 changed files
with
218 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,196 @@ | ||
| package gitlab | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "fmt" | ||
| "time" | ||
| ) | ||
|
|
||
| // ProjectImportExportService handles communication with the project | ||
| // import/export related methods of the GitLab API. | ||
| // | ||
| // GitLab API docs: | ||
| // https://docs.gitlab.com/ce/user/project/settings/import_export.html | ||
| type ProjectImportExportService struct { | ||
| client *Client | ||
| } | ||
|
|
||
| // ImportStatus represents a project import status. | ||
| // | ||
| // GitLab API docs: | ||
| // https://docs.gitlab.com/ce/api/project_import_export.html#import-status | ||
| type ImportStatus struct { | ||
| ID int `json:"id"` | ||
| Description string `json:"description"` | ||
| Name string `json:"name"` | ||
| NameWithNamespace string `json:"name_with_namespace"` | ||
| Path string `json:"path"` | ||
| PathWithNamespace string `json:"path_with_namespace"` | ||
| CreateAt *time.Time `json:"create_at"` | ||
| ImportStatus string `json:"import_status"` | ||
| } | ||
|
|
||
| func (s ImportStatus) String() string { | ||
| return Stringify(s) | ||
| } | ||
|
|
||
| // ExportStatus represents a project export status. | ||
| // | ||
| // GitLab API docs: | ||
| // https://docs.gitlab.com/ce/api/project_import_export.html#export-status | ||
| type ExportStatus struct { | ||
| ID int `json:"id"` | ||
| Description string `json:"description"` | ||
| Name string `json:"name"` | ||
| NameWithNamespace string `json:"name_with_namespace"` | ||
| Path string `json:"path"` | ||
| PathWithNamespace string `json:"path_with_namespace"` | ||
| CreatedAt *time.Time `json:"created_at"` | ||
| ExportStatus string `json:"export_status"` | ||
| Message string `json:"message"` | ||
| Links struct { | ||
| APIURL string `json:"api_url"` | ||
| WebURL string `json:"web_url"` | ||
| } `json:"_links"` | ||
| } | ||
|
|
||
| func (s ExportStatus) String() string { | ||
| return Stringify(s) | ||
| } | ||
|
|
||
| // ScheduleExportOptions represents the available ScheduleExport() options. | ||
| // | ||
| // GitLab API docs: | ||
| // https://docs.gitlab.com/ce/api/project_import_export.html#schedule-an-export | ||
| type ScheduleExportOptions struct { | ||
| Description *string `url:"description,omitempty" json:"description,omitempty"` | ||
| Upload struct { | ||
| URL *string `url:"url,omitempty" json:"url,omitempty"` | ||
| HTTPMethod *string `url:"http_method,omitempty" json:"http_method,omitempty"` | ||
| } `url:"upload,omitempty" json:"upload,omitempty"` | ||
| } | ||
|
|
||
| // ScheduleExport schedules a project export. | ||
| // | ||
| // GitLab API docs: | ||
| // https://docs.gitlab.com/ce/api/project_import_export.html#schedule-an-export | ||
| func (s *ProjectImportExportService) ScheduleExport(pid interface{}, opt *ScheduleExportOptions, options ...OptionFunc) (*Response, error) { | ||
| project, err := parseID(pid) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| u := fmt.Sprintf("projects/%s/export", pathEscape(project)) | ||
|
|
||
| req, err := s.client.NewRequest("POST", u, opt, options) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return s.client.Do(req, nil) | ||
| } | ||
|
|
||
| // ExportStatus get the status of export. | ||
| // | ||
| // GitLab API docs: | ||
| // https://docs.gitlab.com/ce/api/project_import_export.html#export-status | ||
| func (s *ProjectImportExportService) ExportStatus(pid interface{}, options ...OptionFunc) (*ExportStatus, *Response, error) { | ||
| project, err := parseID(pid) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
| u := fmt.Sprintf("projects/%s/export", pathEscape(project)) | ||
|
|
||
| req, err := s.client.NewRequest("GET", u, nil, options) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
|
|
||
| es := new(ExportStatus) | ||
| resp, err := s.client.Do(req, es) | ||
| if err != nil { | ||
| return nil, resp, err | ||
| } | ||
|
|
||
| return es, resp, err | ||
| } | ||
|
|
||
| // ExportDownload download the finished export. | ||
| // | ||
| // GitLab API docs: | ||
| // https://docs.gitlab.com/ce/api/project_import_export.html#export-download | ||
| func (s *ProjectImportExportService) ExportDownload(pid interface{}, options ...OptionFunc) ([]byte, *Response, error) { | ||
| project, err := parseID(pid) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
| u := fmt.Sprintf("projects/%s/export/download", pathEscape(project)) | ||
|
|
||
| req, err := s.client.NewRequest("GET", u, nil, options) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
|
|
||
| var b bytes.Buffer | ||
| resp, err := s.client.Do(req, &b) | ||
| if err != nil { | ||
| return nil, resp, err | ||
| } | ||
|
|
||
| return b.Bytes(), resp, err | ||
| } | ||
|
|
||
| // ImportFileOptions represents the available ImportFile() options. | ||
| // | ||
| // GitLab API docs: | ||
| // https://docs.gitlab.com/ce/api/project_import_export.html#import-a-file | ||
| type ImportFileOptions struct { | ||
| Namespace *string `url:"namespace,omitempty" json:"namespace,omitempty"` | ||
| File *string `url:"file,omitempty" json:"file,omitempty"` | ||
| Path *string `url:"path,omitempty" json:"path,omitempty"` | ||
| Overwrite *bool `url:"overwrite,omitempty" json:"overwrite,omitempty"` | ||
| OverrideParams *CreateProjectOptions `url:"override_params,omitempty" json:"override_params,omitempty"` | ||
| } | ||
|
|
||
| // ImportProject import the project. | ||
| // | ||
| // GitLab API docs: | ||
| // https://docs.gitlab.com/ce/api/project_import_export.html#import-a-file | ||
| func (s *ProjectImportExportService) ImportProject(opt *ImportFileOptions, options ...OptionFunc) (*ImportStatus, *Response, error) { | ||
| req, err := s.client.NewRequest("POST", "/projects/import", opt, options) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
|
|
||
| is := new(ImportStatus) | ||
| resp, err := s.client.Do(req, is) | ||
| if err != nil { | ||
| return nil, resp, err | ||
| } | ||
|
|
||
| return is, resp, err | ||
| } | ||
|
|
||
| // ImportStatus get the status of an import. | ||
| // | ||
| // GitLab API docs: | ||
| // https://docs.gitlab.com/ce/api/project_import_export.html#import-status | ||
| func (s *ProjectImportExportService) ImportStatus(pid interface{}, options ...OptionFunc) (*ImportStatus, *Response, error) { | ||
| project, err := parseID(pid) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
| u := fmt.Sprintf("projects/%s/import", pathEscape(project)) | ||
|
|
||
| req, err := s.client.NewRequest("GET", u, nil, options) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
|
|
||
| is := new(ImportStatus) | ||
| resp, err := s.client.Do(req, is) | ||
| if err != nil { | ||
| return nil, resp, err | ||
| } | ||
|
|
||
| return is, resp, err | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters