bump code.gitea.io/sdk/gitea from untaged to 0.11.0 #92
Merged
techknowlogick
merged 1 commits from 6543/tea:sdk-update into master 3 years ago
23 changed files with 1459 additions and 54 deletions
@ -0,0 +1,24 @@ |
||||
// Copyright 2020 The Gitea Authors. All rights reserved.
|
||||
// Use of this source code is governed by a MIT-style
|
||||
// license that can be found in the LICENSE file.
|
||||
|
||||
package gitea |
||||
|
||||
import ( |
||||
"fmt" |
||||
) |
||||
|
||||
// GitBlobResponse represents a git blob
|
||||
type GitBlobResponse struct { |
||||
Content string `json:"content"` |
||||
Encoding string `json:"encoding"` |
||||
URL string `json:"url"` |
||||
SHA string `json:"sha"` |
||||
Size int64 `json:"size"` |
||||
} |
||||
|
||||
// GetBlob get the blob of a repository file
|
||||
func (c *Client) GetBlob(user, repo, sha string) (*GitBlobResponse, error) { |
||||
blob := new(GitBlobResponse) |
||||
return blob, c.getParsedResponse("GET", fmt.Sprintf("/repos/%s/%s/git/blobs/%s", user, repo, sha), nil, nil, blob) |
||||
} |
||||
@ -1,3 +1,8 @@ |
||||
module code.gitea.io/sdk/gitea |
||||
|
||||
go 1.12 |
||||
|
||||
require ( |
||||
github.com/hashicorp/go-version v1.2.0 |
||||
github.com/stretchr/testify v1.4.0 |
||||
) |
||||
|
||||
@ -0,0 +1,13 @@ |
||||
github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8= |
||||
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= |
||||
github.com/hashicorp/go-version v1.2.0 h1:3vNe/fWF5CBgRIguda1meWhsZHy3m8gCJ5wx+dIzX/E= |
||||
github.com/hashicorp/go-version v1.2.0/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA= |
||||
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= |
||||
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= |
||||
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= |
||||
github.com/stretchr/testify v1.4.0 h1:2E4SXV/wtOkTonXsotYi4li6zVWxYlZuYNCXe9XRJyk= |
||||
github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= |
||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= |
||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= |
||||
gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw= |
||||
gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= |
||||
@ -0,0 +1,98 @@ |
||||
// Copyright 2020 The Gitea Authors. All rights reserved.
|
||||
// Use of this source code is governed by a MIT-style
|
||||
// license that can be found in the LICENSE file.
|
||||
|
||||
package gitea |
||||
|
||||
import ( |
||||
"bytes" |
||||
"encoding/json" |
||||
"fmt" |
||||
"time" |
||||
) |
||||
|
||||
// Reaction contain one reaction
|
||||
type Reaction struct { |
||||
User *User `json:"user"` |
||||
Reaction string `json:"content"` |
||||
Created time.Time `json:"created_at"` |
||||
} |
||||
|
||||
// GetIssueReactions get a list reactions of an issue
|
||||
func (c *Client) GetIssueReactions(owner, repo string, index int64) ([]*Reaction, error) { |
||||
if err := c.CheckServerVersionConstraint(">=1.11.0"); err != nil { |
||||
return nil, err |
||||
} |
||||
reactions := make([]*Reaction, 0, 10) |
||||
return reactions, c.getParsedResponse("GET", fmt.Sprintf("/repos/%s/%s/issues/%d/reactions", owner, repo, index), nil, nil, &reactions) |
||||
} |
||||
|
||||
// GetIssueCommentReactions get a list of reactions from a comment of an issue
|
||||
func (c *Client) GetIssueCommentReactions(owner, repo string, commentID int64) ([]*Reaction, error) { |
||||
if err := c.CheckServerVersionConstraint(">=1.11.0"); err != nil { |
||||
return nil, err |
||||
} |
||||
reactions := make([]*Reaction, 0, 10) |
||||
return reactions, c.getParsedResponse("GET", fmt.Sprintf("/repos/%s/%s/issues/comments/%d/reactions", owner, repo, commentID), nil, nil, &reactions) |
||||
} |
||||
|
||||
// editReactionOption contain the reaction type
|
||||
type editReactionOption struct { |
||||
Reaction string `json:"content"` |
||||
} |
||||
|
||||
// PostIssueReaction add a reaction to an issue
|
||||
func (c *Client) PostIssueReaction(owner, repo string, index int64, reaction string) (*Reaction, error) { |
||||
if err := c.CheckServerVersionConstraint(">=1.11.0"); err != nil { |
||||
return nil, err |
||||
} |
||||
reactionResponse := new(Reaction) |
||||
body, err := json.Marshal(&editReactionOption{Reaction: reaction}) |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
return reactionResponse, c.getParsedResponse("POST", fmt.Sprintf("/repos/%s/%s/issues/%d/reactions", owner, repo, index), |
||||
jsonHeader, bytes.NewReader(body), reactionResponse) |
||||
} |
||||
|
||||
// DeleteIssueReaction remove a reaction from an issue
|
||||
func (c *Client) DeleteIssueReaction(owner, repo string, index int64, reaction string) error { |
||||
if err := c.CheckServerVersionConstraint(">=1.11.0"); err != nil { |
||||
return err |
||||
} |
||||
body, err := json.Marshal(&editReactionOption{Reaction: reaction}) |
||||
if err != nil { |
||||
return err |
||||
} |
||||
_, err = c.getResponse("DELETE", fmt.Sprintf("/repos/%s/%s/issues/%d/reactions", owner, repo, index), jsonHeader, bytes.NewReader(body)) |
||||
return err |
||||
} |
||||
|
||||
// PostIssueCommentReaction add a reaction to a comment of an issue
|
||||
func (c *Client) PostIssueCommentReaction(owner, repo string, commentID int64, reaction string) (*Reaction, error) { |
||||
if err := c.CheckServerVersionConstraint(">=1.11.0"); err != nil { |
||||
return nil, err |
||||
} |
||||
reactionResponse := new(Reaction) |
||||
body, err := json.Marshal(&editReactionOption{Reaction: reaction}) |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
return reactionResponse, c.getParsedResponse("POST", fmt.Sprintf("/repos/%s/%s/issues/comments/%d/reactions", owner, repo, commentID), |
||||
jsonHeader, bytes.NewReader(body), reactionResponse) |
||||
} |
||||
|
||||
// DeleteIssueCommentReaction remove a reaction from a comment of an issue
|
||||
func (c *Client) DeleteIssueCommentReaction(owner, repo string, commentID int64, reaction string) error { |
||||
if err := c.CheckServerVersionConstraint(">=1.11.0"); err != nil { |
||||
return err |
||||
} |
||||
// swagger:operation DELETE /repos/{owner}/{repo}/issues/comments/{id}/reactions issue issueDeleteCommentReaction
|
||||
body, err := json.Marshal(&editReactionOption{Reaction: reaction}) |
||||
if err != nil { |
||||
return err |
||||
} |
||||
_, err = c.getResponse("DELETE", fmt.Sprintf("/repos/%s/%s/issues/comments/%d/reactions", owner, repo, commentID), |
||||
jsonHeader, bytes.NewReader(body)) |
||||
return err |
||||
} |
||||
@ -0,0 +1,42 @@ |
||||
// Copyright 2020 The Gitea Authors. All rights reserved.
|
||||
// Use of this source code is governed by a MIT-style
|
||||
// license that can be found in the LICENSE file.
|
||||
|
||||
package gitea |
||||
|
||||
import ( |
||||
"fmt" |
||||
"time" |
||||
) |
||||
|
||||
// StopWatch represents a running stopwatch of an issue / pr
|
||||
type StopWatch struct { |
||||
Created time.Time `json:"created"` |
||||
IssueIndex int64 `json:"issue_index"` |
||||
} |
||||
|
||||
// GetMyStopwatches list all stopwatches
|
||||
func (c *Client) GetMyStopwatches() ([]*StopWatch, error) { |
||||
stopwatches := make([]*StopWatch, 0, 1) |
||||
return stopwatches, c.getParsedResponse("GET", "/user/stopwatches", nil, nil, &stopwatches) |
||||
} |
||||
|
||||
// DeleteIssueStopwatch delete / cancel a specific stopwatch
|
||||
func (c *Client) DeleteIssueStopwatch(owner, repo string, index int64) error { |
||||
_, err := c.getResponse("DELETE", fmt.Sprintf("/repos/%s/%s/issues/%d/stopwatch/delete", owner, repo, index), nil, nil) |
||||
return err |
||||
} |
||||
|
||||
// StartIssueStopWatch starts a stopwatch for an existing issue for a given
|
||||
// repository
|
||||
func (c *Client) StartIssueStopWatch(owner, repo string, index int64) error { |
||||
_, err := c.getResponse("POST", fmt.Sprintf("/repos/%s/%s/issues/%d/stopwatch/start", owner, repo, index), nil, nil) |
||||
return err |
||||
} |
||||
|
||||
// StopIssueStopWatch stops an existing stopwatch for an issue in a given
|
||||
// repository
|
||||
func (c *Client) StopIssueStopWatch(owner, repo string, index int64) error { |
||||
_, err := c.getResponse("POST", fmt.Sprintf("/repos/%s/%s/issues/%d/stopwatch/stop", owner, repo, index), nil, nil) |
||||
return err |
||||
} |
||||
@ -0,0 +1,54 @@ |
||||
// Copyright 2020 The Gitea Authors. All rights reserved.
|
||||
// Use of this source code is governed by a MIT-style
|
||||
// license that can be found in the LICENSE file.
|
||||
|
||||
package gitea |
||||
|
||||
import ( |
||||
"fmt" |
||||
) |
||||
|
||||
// GetIssueSubscribers get list of users who subscribed on an issue
|
||||
func (c *Client) GetIssueSubscribers(owner, repo string, index int64) ([]*User, error) { |
||||
if err := c.CheckServerVersionConstraint(">=1.11.0"); err != nil { |
||||
return nil, err |
||||
} |
||||
subscribers := make([]*User, 0, 10) |
||||
return subscribers, c.getParsedResponse("GET", fmt.Sprintf("/repos/%s/%s/issues/%d/subscriptions", owner, repo, index), nil, nil, &subscribers) |
||||
} |
||||
|
||||
// AddIssueSubscription Subscribe user to issue
|
||||
func (c *Client) AddIssueSubscription(owner, repo string, index int64, user string) error { |
||||
if err := c.CheckServerVersionConstraint(">=1.11.0"); err != nil { |
||||
return err |
||||
} |
||||
_, err := c.getResponse("PUT", fmt.Sprintf("/repos/%s/%s/issues/%d/subscriptions/%s", owner, repo, index, user), nil, nil) |
||||
return err |
||||
} |
||||
|
||||
// DeleteIssueSubscription unsubscribe user from issue
|
||||
func (c *Client) DeleteIssueSubscription(owner, repo string, index int64, user string) error { |
||||
if err := c.CheckServerVersionConstraint(">=1.11.0"); err != nil { |
||||
return err |
||||
} |
||||
_, err := c.getResponse("DELETE", fmt.Sprintf("/repos/%s/%s/issues/%d/subscriptions/%s", owner, repo, index, user), nil, nil) |
||||
return err |
||||
} |
||||
|
||||
// IssueSubscribe subscribe current user to an issue
|
||||
func (c *Client) IssueSubscribe(owner, repo string, index int64) error { |
||||
u, err := c.GetMyUserInfo() |
||||
if err != nil { |
||||
return err |
||||
} |
||||
return c.AddIssueSubscription(owner, repo, index, u.UserName) |
||||
} |
||||
|
||||
// IssueUnSubscribe unsubscribe current user from an issue
|
||||
func (c *Client) IssueUnSubscribe(owner, repo string, index int64) error { |
||||
u, err := c.GetMyUserInfo() |
||||
if err != nil { |
||||
return err |
||||
} |
||||
return c.DeleteIssueSubscription(owner, repo, index, u.UserName) |
||||
} |
||||
@ -1,13 +0,0 @@ |
||||
// Copyright 2015 The Gogs Authors. All rights reserved.
|
||||
// Use of this source code is governed by a MIT-style
|
||||
// license that can be found in the LICENSE file.
|
||||
|
||||
package gitea |
||||
|
||||
// ServerVersion returns the version of the server
|
||||
func (c *Client) ServerVersion() (string, error) { |
||||
var v = struct { |
||||
Version string `json:"version"` |
||||
}{} |
||||
return v.Version, c.getParsedResponse("GET", "/version", nil, nil, &v) |
||||
} |
||||
@ -0,0 +1,57 @@ |
||||
// Copyright 2020 The Gitea Authors. All rights reserved.
|
||||
// Use of this source code is governed by a MIT-style
|
||||
// license that can be found in the LICENSE file.
|
||||
|
||||
package gitea |
||||
|
||||
import ( |
||||
"fmt" |
||||
|
||||
"github.com/hashicorp/go-version" |
||||
) |
||||
|
||||
// ServerVersion returns the version of the server
|
||||
func (c *Client) ServerVersion() (string, error) { |
||||
var v = struct { |
||||
Version string `json:"version"` |
||||
}{} |
||||
return v.Version, c.getParsedResponse("GET", "/version", nil, nil, &v) |
||||
} |
||||
|
||||
// CheckServerVersionConstraint validates that the login's server satisfies a
|
||||
// given version constraint such as ">= 1.11.0+dev"
|
||||
func (c *Client) CheckServerVersionConstraint(constraint string) error { |
||||
c.versionLock.RLock() |
||||
if c.serverVersion == nil { |
||||
c.versionLock.RUnlock() |
||||
if err := c.loadClientServerVersion(); err != nil { |
||||
return err |
||||
} |
||||
} else { |
||||
c.versionLock.RUnlock() |
||||
} |
||||
|
||||
check, err := version.NewConstraint(constraint) |
||||
if err != nil { |
||||
return err |
||||
} |
||||
if !check.Check(c.serverVersion) { |
||||
return fmt.Errorf("gitea server at %s does not satisfy version constraint %s", c.url, constraint) |
||||
} |
||||
return nil |
||||
} |
||||
|
||||
// loadClientServerVersion init the serverVersion variable
|
||||
func (c *Client) loadClientServerVersion() error { |
||||
c.versionLock.Lock() |
||||
defer c.versionLock.Unlock() |
||||
|
||||
raw, err := c.ServerVersion() |
||||
if err != nil { |
||||
return err |
||||
} |
||||
if c.serverVersion, err = version.NewVersion(raw); err != nil { |
||||
return err |
||||
} |
||||
return nil |
||||
} |
||||
@ -0,0 +1,13 @@ |
||||
language: go |
||||
|
||||
go: |
||||
- 1.2 |
||||
- 1.3 |
||||
- 1.4 |
||||
- 1.9 |
||||
- "1.10" |
||||
- 1.11 |
||||
- 1.12 |
||||
|
||||
script: |
||||
- go test |
||||
@ -0,0 +1,354 @@ |
||||
Mozilla Public License, version 2.0 |
||||
|
||||
1. Definitions |
||||
|
||||
1.1. “Contributor” |
||||
|
||||
means each individual or legal entity that creates, contributes to the |
||||
creation of, or owns Covered Software. |
||||
|
||||
1.2. “Contributor Version” |
||||
|
||||
means the combination of the Contributions of others (if any) used by a |
||||
Contributor and that particular Contributor’s Contribution. |
||||
|
||||
1.3. “Contribution” |
||||
|
||||
means Covered Software of a particular Contributor. |
||||
|
||||
1.4. “Covered Software” |
||||
|
||||
means Source Code Form to which the initial Contributor has attached the |
||||
notice in Exhibit A, the Executable Form of such Source Code Form, and |
||||
Modifications of such Source Code Form, in each case including portions |
||||
thereof. |
||||
|
||||
1.5. “Incompatible With Secondary Licenses” |
||||
means |
||||
|
||||
a. that the initial Contributor has attached the notice described in |
||||
Exhibit B to the Covered Software; or |
||||
|
||||
b. that the Covered Software was made available under the terms of version |
||||
1.1 or earlier of the License, but not also under the terms of a |
||||
Secondary License. |
||||
|
||||
1.6. “Executable Form” |
||||
|
||||
means any form of the work other than Source Code Form. |
||||
|
||||
1.7. “Larger Work” |
||||
|
||||
means a work that combines Covered Software with other material, in a separate |
||||
file or files, that is not Covered Software. |
||||
|
||||
1.8. “License” |
||||
|
||||
means this document. |
||||
|
||||
1.9. “Licensable” |
||||
|
||||
means having the right to grant, to the maximum extent possible, whether at the |
||||
time of the initial grant or subsequently, any and all of the rights conveyed by |
||||
this License. |
||||
|
||||
1.10. “Modifications” |
||||
|
||||
means any of the following: |
||||
|
||||
a. any file in Source Code Form that results from an addition to, deletion |
||||
from, or modification of the contents of Covered Software; or |
||||
|
||||
b. any new file in Source Code Form that contains any Covered Software. |
||||
|
||||
1.11. “Patent Claims” of a Contributor |
||||
|
||||
means any patent claim(s), including without limitation, method, process, |
||||
and apparatus claims, in any patent Licensable by such Contributor that |
||||
would be infringed, but for the grant of the License, by the making, |
||||
using, selling, offering for sale, having made, import, or transfer of |
||||
either its Contributions or its Contributor Version. |
||||
|
||||
1.12. “Secondary License” |
||||
|
||||
means either the GNU General Public License, Version 2.0, the GNU Lesser |
||||
General Public License, Version 2.1, the GNU Affero General Public |
||||
License, Version 3.0, or any later versions of those licenses. |
||||
|
||||
1.13. “Source Code Form” |
||||
|
||||
means the form of the work preferred for making modifications. |
||||
|
||||
1.14. “You” (or “Your”) |
||||
|
||||
means an individual or a legal entity exercising rights under this |
||||
License. For legal entities, “You” includes any entity that controls, is |
||||
controlled by, or is under common control with You. For purposes of this |
||||
definition, “control” means (a) the power, direct or indirect, to cause |
||||
the direction or management of such entity, whether by contract or |
||||
otherwise, or (b) ownership of more than fifty percent (50%) of the |
||||
outstanding shares or beneficial ownership of such entity. |
||||
|
||||
|
||||
2. License Grants and Conditions |
||||
|
||||
2.1. Grants |
||||
|
||||
Each Contributor hereby grants You a world-wide, royalty-free, |
||||
non-exclusive license: |
||||
|
||||
a. under intellectual property rights (other than patent or trademark) |
||||
Licensable by such Contributor to use, reproduce, make available, |
||||
modify, display, perform, distribute, and otherwise exploit its |
||||
Contributions, either on an unmodified basis, with Modifications, or as |
||||
part of a Larger Work; and |
||||
|
||||
b. under Patent Claims of such Contributor to make, use, sell, offer for |
||||
sale, have made, import, and otherwise transfer either its Contributions |
||||
or its Contributor Version. |
||||
|
||||
2.2. Effective Date |
||||
|
||||
The licenses granted in Section 2.1 with respect to any Contribution become |
||||
effective for each Contribution on the date the Contributor first distributes |
||||
such Contribution. |
||||
|
||||
2.3. Limitations on Grant Scope |
||||
|
||||
The licenses granted in this Section 2 are the only rights granted under this |
||||
License. No additional rights or licenses will be implied from the distribution |
||||
or licensing of Covered Software under this License. Notwithstanding Section |
||||
2.1(b) above, no patent license is granted by a Contributor: |
||||
|
||||
a. for any code that a Contributor has removed from Covered Software; or |
||||
|
||||
b. for infringements caused by: (i) Your and any other third party’s |
||||
modifications of Covered Software, or (ii) the combination of its |
||||
Contributions with other software (except as part of its Contributor |
||||
Version); or |
||||
|
||||
c. under Patent Claims infringed by Covered Software in the absence of its |
||||
Contributions. |
||||
|
||||
This License does not grant any rights in the trademarks, service marks, or |
||||
logos of any Contributor (except as may be necessary to comply with the |
||||
notice requirements in Section 3.4). |
||||
|
||||
2.4. Subsequent Licenses |
||||
|
||||
No Contributor makes additional grants as a result of Your choice to |
||||
distribute the Covered Software under a subsequent version of this License |
||||
(see Section 10.2) or under the terms of a Secondary License (if permitted |
||||
under the terms of Section 3.3). |
||||
|
||||
2.5. Representation |
||||
|
||||
Each Contributor represents that the Contributor believes its Contributions |
||||
are its original creation(s) or it has sufficient rights to grant the |
||||
rights to its Contributions conveyed by this License. |
||||
|
||||
2.6. Fair Use |
||||
|
||||
This License is not intended to limit any rights You have under applicable |
||||
copyright doctrines of fair use, fair dealing, or other equivalents. |
||||
|
||||
2.7. Conditions |
||||
|
||||
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in |
||||
Section 2.1. |
||||
|
||||
|
||||
3. Responsibilities |
||||
|
||||
3.1. Distribution of Source Form |
||||
|
||||
All distribution of Covered Software in Source Code Form, including any |
||||
Modifications that You create or to which You contribute, must be under the |
||||
terms of this License. You must inform recipients that the Source Code Form |
||||
of the Covered Software is governed by the terms of this License, and how |
||||
they can obtain a copy of this License. You may not attempt to alter or |
||||
restrict the recipients’ rights in the Source Code Form. |
||||
|
||||
3.2. Distribution of Executable Form |
||||
|
||||
If You distribute Covered Software in Executable Form then: |
||||
|
||||
a. such Covered Software must also be made available in Source Code Form, |
||||
as described in Section 3.1, and You must inform recipients of the |
||||
Executable Form how they can obtain a copy of such Source Code Form by |
||||
reasonable means in a timely manner, at a charge no more than the cost |
||||
of distribution to the recipient; and |
||||
|
||||
b. You may distribute such Executable Form under the terms of this License, |
||||
or sublicense it under different terms, provided that the license for |
||||
the Executable Form does not attempt to limit or alter the recipients’ |
||||
rights in the Source Code Form under this License. |
||||
|
||||
3.3. Distribution of a Larger Work |
||||
|
||||
You may create and distribute a Larger Work under terms of Your choice, |
||||
provided that You also comply with the requirements of this License for the |
||||
Covered Software. If the Larger Work is a combination of Covered Software |
||||
with a work governed by one or more Secondary Licenses, and the Covered |
||||
Software is not Incompatible With Secondary Licenses, this License permits |
||||
You to additionally distribute such Covered Software under the terms of |
||||
such Secondary License(s), so that the recipient of the Larger Work may, at |
||||
their option, further distribute the Covered Software under the terms of |
||||
either this License or such Secondary License(s). |
||||
|
||||
3.4. Notices |
||||
|
||||
You may not remove or alter the substance of any license notices (including |
||||
copyright notices, patent notices, disclaimers of warranty, or limitations |
||||
of liability) contained within the Source Code Form of the Covered |
||||
Software, except that You may alter any license notices to the extent |
||||
required to remedy known factual inaccuracies. |
||||
|
||||
3.5. Application of Additional Terms |
||||
|
||||
You may choose to offer, and to charge a fee for, warranty, support, |
||||
indemnity or liability obligations to one or more recipients of Covered |
||||
Software. However, You may do so only on Your own behalf, and not on behalf |
||||
of any Contributor. You must make it absolutely clear that any such |
||||
warranty, support, indemnity, or liability obligation is offered by You |
||||
alone, and You hereby agree to indemnify every Contributor for any |
||||
liability incurred by such Contributor as a result of warranty, support, |
||||
indemnity or liability terms You offer. You may include additional |
||||
disclaimers of warranty and limitations of liability specific to any |
||||
jurisdiction. |
||||
|
||||
4. Inability to Comply Due to Statute or Regulation |
||||
|
||||
If it is impossible for You to comply with any of the terms of this License |
||||
with respect to some or all of the Covered Software due to statute, judicial |
||||
order, or regulation then You must: (a) comply with the terms of this License |
||||
to the maximum extent possible; and (b) describe the limitations and the code |
||||
they affect. Such description must be placed in a text file included with all |
||||
distributions of the Covered Software under this License. Except to the |
||||
extent prohibited by statute or regulation, such description must be |
||||
sufficiently detailed for a recipient of ordinary skill to be able to |
||||
understand it. |
||||
|
||||
5. Termination |
||||
|
||||
5.1. The rights granted under this License will terminate automatically if You |
||||
fail to comply with any of its terms. However, if You become compliant, |
||||
then the rights granted under this License from a particular Contributor |
||||
are reinstated (a) provisionally, unless and until such Contributor |
||||
explicitly and finally terminates Your grants, and (b) on an ongoing basis, |
||||
if such Contributor fails to notify You of the non-compliance by some |
||||
reasonable means prior to 60 days after You have come back into compliance. |
||||
Moreover, Your grants from a particular Contributor are reinstated on an |
||||
ongoing basis if such Contributor notifies You of the non-compliance by |
||||
some reasonable means, this is the first time You have received notice of |
||||
non-compliance with this License from such Contributor, and You become |
||||
compliant prior to 30 days after Your receipt of the notice. |
||||
|
||||
5.2. If You initiate litigation against any entity by asserting a patent |
||||
infringement claim (excluding declaratory judgment actions, counter-claims, |
||||
and cross-claims) alleging that a Contributor Version directly or |
||||
indirectly infringes any patent, then the rights granted to You by any and |
||||
all Contributors for the Covered Software under Section 2.1 of this License |
||||
shall terminate. |
||||
|
||||
5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user |
||||
license agreements (excluding distributors and resellers) which have been |
||||
validly granted by You or Your distributors under this License prior to |
||||
termination shall survive termination. |
||||
|
||||
6. Disclaimer of Warranty |
||||
|
||||
Covered Software is provided under this License on an “as is” basis, without |
||||
warranty of any kind, either expressed, implied, or statutory, including, |
||||
without limitation, warranties that the Covered Software is free of defects, |
||||
merchantable, fit for a particular purpose or non-infringing. The entire |
||||
risk as to the quality and performance of the Covered Software is with You. |
||||
Should any Covered Software prove defective in any respect, You (not any |
||||
Contributor) assume the cost of any necessary servicing, repair, or |
||||
correction. This disclaimer of warranty constitutes an essential part of this |
||||
License. No use of any Covered Software is authorized under this License |
||||
except under this disclaimer. |
||||
|
||||
7. Limitation of Liability |
||||
|
||||
Under no circumstances and under no legal theory, whether tort (including |
||||
negligence), contract, or otherwise, shall any Contributor, or anyone who |
||||
distributes Covered Software as permitted above, be liable to You for any |
||||
direct, indirect, special, incidental, or consequential damages of any |
||||
character including, without limitation, damages for lost profits, loss of |
||||
goodwill, work stoppage, computer failure or malfunction, or any and all |
||||
other commercial damages or losses, even if such party shall have been |
||||
informed of the possibility of such damages. This limitation of liability |
||||
shall not apply to liability for death or personal injury resulting from such |
||||
party’s negligence to the extent applicable law prohibits such limitation. |
||||
Some jurisdictions do not allow the exclusion or limitation of incidental or |
||||
consequential damages, so this exclusion and limitation may not apply to You. |
||||
|
||||
8. Litigation |
||||
|
||||
Any litigation relating to this License may be brought only in the courts of |
||||
a jurisdiction where the defendant maintains its principal place of business |
||||
and such litigation shall be governed by laws of that jurisdiction, without |
||||
reference to its conflict-of-law provisions. Nothing in this Section shall |
||||
prevent a party’s ability to bring cross-claims or counter-claims. |
||||
|
||||
9. Miscellaneous |
||||
|
||||
This License represents the complete agreement concerning the subject matter |
||||
hereof. If any provision of this License is held to be unenforceable, such |
||||
provision shall be reformed only to the extent necessary to make it |
||||
enforceable. Any law or regulation which provides that the language of a |
||||
contract shall be construed against the drafter shall not be used to construe |
||||
this License against a Contributor. |
||||
|
||||
|
||||
10. Versions of the License |
||||
|
||||
10.1. New Versions |
||||
|
||||
Mozilla Foundation is the license steward. Except as provided in Section |
||||
10.3, no one other than the license steward has the right to modify or |
||||
publish new versions of this License. Each version will be given a |
||||
distinguishing version number. |
||||
|
||||
10.2. Effect of New Versions |
||||
|
||||
You may distribute the Covered Software under the terms of the version of |
||||
the License under which You originally received the Covered Software, or |
||||
under the terms of any subsequent version published by the license |
||||
steward. |
||||
|
||||
10.3. Modified Versions |
||||
|
||||
If you create software not governed by this License, and you want to |
||||
create a new license for such software, you may create and use a modified |
||||
version of this License if you rename the license and remove any |
||||
references to the name of the license steward (except to note that such |
||||
modified license differs from this License). |
||||
|
||||
10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses |
||||
If You choose to distribute Source Code Form that is Incompatible With |
||||
Secondary Licenses under the terms of this version of the License, the |
||||
notice described in Exhibit B of this License must be attached. |
||||
|
||||
Exhibit A - Source Code Form License Notice |
||||
|
||||
This Source Code Form is subject to the |
||||
terms of the Mozilla Public License, v. |
||||
2.0. If a copy of the MPL was not |
||||
distributed with this file, You can |
||||
obtain one at |
||||
http://mozilla.org/MPL/2.0/. |
||||
|
||||
If it is not possible or desirable to put the notice in a particular file, then |
||||
You may include the notice in a location (such as a LICENSE file in a relevant |
||||
directory) where a recipient would be likely to look for such a notice. |
||||
|
||||
You may add additional accurate notices of copyright ownership. |
||||
|
||||
Exhibit B - “Incompatible With Secondary Licenses” Notice |
||||
|
||||
This Source Code Form is “Incompatible |
||||
With Secondary Licenses”, as defined by |
||||
the Mozilla Public License, v. 2.0. |
||||
|
||||
@ -0,0 +1,65 @@ |
||||
# Versioning Library for Go |
||||
[](https://travis-ci.org/hashicorp/go-version) |
||||
|
||||
go-version is a library for parsing versions and version constraints, |
||||
and verifying versions against a set of constraints. go-version |
||||
can sort a collection of versions properly, handles prerelease/beta |
||||
versions, can increment versions, etc. |
||||
|
||||
Versions used with go-version must follow [SemVer](http://semver.org/). |
||||
|
||||
## Installation and Usage |
||||
|
||||
Package documentation can be found on |
||||
[GoDoc](http://godoc.org/github.com/hashicorp/go-version). |
||||
|
||||
Installation can be done with a normal `go get`: |
||||
|
||||
``` |
||||
$ go get github.com/hashicorp/go-version |
||||
``` |
||||
|
||||
#### Version Parsing and Comparison |
||||
|
||||
```go |
||||
v1, err := version.NewVersion("1.2") |
||||
v2, err := version.NewVersion("1.5+metadata") |
||||
|
||||
// Comparison example. There is also GreaterThan, Equal, and just |
||||
// a simple Compare that returns an int allowing easy >=, <=, etc. |
||||
if v1.LessThan(v2) { |
||||
fmt.Printf("%s is less than %s", v1, v2) |
||||
} |
||||
``` |
||||
|
||||
#### Version Constraints |
||||
|
||||
```go |
||||
v1, err := version.NewVersion("1.2") |
||||
|
||||
// Constraints example. |
||||
constraints, err := version.NewConstraint(">= 1.0, < 1.4") |
||||
if constraints.Check(v1) { |
||||
fmt.Printf("%s satisfies constraints %s", v1, constraints) |
||||
} |
||||
``` |
||||
|
||||
#### Version Sorting |
||||
|
||||
```go |
||||
versionsRaw := []string{"1.1", "0.7.1", "1.4-beta", "1.4", "2"} |
||||
versions := make([]*version.Version, len(versionsRaw)) |
||||
for i, raw := range versionsRaw { |
||||
v, _ := version.NewVersion(raw) |
||||
versions[i] = v |
||||
} |
||||
|
||||
// After this, the versions are properly sorted |
||||
sort.Sort(version.Collection(versions)) |
||||
``` |
||||
|
||||
## Issues and Contributing |
||||
|
||||
If you find an issue with this library, please report an issue. If you'd |
||||
like, we welcome any contributions. Fork this library and submit a pull |
||||
request. |
||||
@ -0,0 +1,204 @@ |
||||
package version |
||||
|
||||
import ( |
||||
"fmt" |
||||
"reflect" |
||||
"regexp" |
||||
"strings" |
||||
) |
||||
|
||||
// Constraint represents a single constraint for a version, such as
|
||||
// ">= 1.0".
|
||||
type Constraint struct { |
||||
f constraintFunc |
||||
check *Version |
||||
original string |
||||
} |
||||
|
||||
// Constraints is a slice of constraints. We make a custom type so that
|
||||
// we can add methods to it.
|
||||
type Constraints []*Constraint |
||||
|
||||
type constraintFunc func(v, c *Version) bool |
||||
|
||||
var constraintOperators map[string]constraintFunc |
||||
|
||||
var constraintRegexp *regexp.Regexp |
||||
|
||||
func init() { |
||||
constraintOperators = map[string]constraintFunc{ |
||||
"": constraintEqual, |
||||
"=": constraintEqual, |
||||
"!=": constraintNotEqual, |
||||
">": constraintGreaterThan, |
||||
"<": constraintLessThan, |
||||
">=": constraintGreaterThanEqual, |
||||
"<=": constraintLessThanEqual, |
||||
"~>": constraintPessimistic, |
||||
} |
||||
|
||||
ops := make([]string, 0, len(constraintOperators)) |
||||
for k := range constraintOperators { |
||||
ops = append(ops, regexp.QuoteMeta(k)) |
||||
} |
||||
|
||||
constraintRegexp = regexp.MustCompile(fmt.Sprintf( |
||||
`^\s*(%s)\s*(%s)\s*$`, |
||||
strings.Join(ops, "|"), |
||||
VersionRegexpRaw)) |
||||
} |
||||
|
||||
// NewConstraint will parse one or more constraints from the given
|
||||
// constraint string. The string must be a comma-separated list of
|
||||
// constraints.
|
||||
func NewConstraint(v string) (Constraints, error) { |
||||
vs := strings.Split(v, ",") |
||||
result := make([]*Constraint, len(vs)) |
||||
for i, single := range vs { |
||||
c, err := parseSingle(single) |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
|
||||
result[i] = c |
||||
} |
||||
|
||||
return Constraints(result), nil |
||||
} |
||||
|
||||
// Check tests if a version satisfies all the constraints.
|
||||
func (cs Constraints) Check(v *Version) bool { |
||||
for _, c := range cs { |
||||
if !c.Check(v) { |
||||
return false |
||||
} |
||||
} |
||||
|
||||
return true |
||||
} |
||||
|
||||
// Returns the string format of the constraints
|
||||
func (cs Constraints) String() string { |
||||
csStr := make([]string, len(cs)) |
||||
for i, c := range cs { |
||||
csStr[i] = c.String() |
||||
} |
||||
|
||||
return strings.Join(csStr, ",") |
||||
} |
||||
|
||||
// Check tests if a constraint is validated by the given version.
|
||||
func (c *Constraint) Check(v *Version) bool { |
||||
return c.f(v, c.check) |
||||
} |
||||
|
||||
func (c *Constraint) String() string { |
||||
return c.original |
||||
} |
||||
|
||||
func parseSingle(v string) (*Constraint, error) { |
||||
matches := constraintRegexp.FindStringSubmatch(v) |
||||
if matches == nil { |
||||
return nil, fmt.Errorf("Malformed constraint: %s", v) |
||||
} |
||||
|
||||
check, err := NewVersion(matches[2]) |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
|
||||
return &Constraint{ |
||||
f: constraintOperators[matches[1]], |
||||
check: check, |
||||
original: v, |
||||
}, nil |
||||
} |
||||
|
||||
func prereleaseCheck(v, c *Version) bool { |
||||
switch vPre, cPre := v.Prerelease() != "", c.Prerelease() != ""; { |
||||
case cPre && vPre: |
||||
// A constraint with a pre-release can only match a pre-release version
|
||||
// with the same base segments.
|
||||
return reflect.DeepEqual(c.Segments64(), v.Segments64()) |
||||
|
||||
case !cPre && vPre: |
||||
// A constraint without a pre-release can only match a version without a
|
||||
// pre-release.
|
||||
return false |
||||
|
||||
case cPre && !vPre: |
||||
// OK, except with the pessimistic operator
|
||||
case !cPre && !vPre: |
||||
// OK
|
||||
} |
||||
return true |
||||
} |
||||
|
||||
//-------------------------------------------------------------------
|
||||
// Constraint functions
|
||||
//-------------------------------------------------------------------
|
||||
|
||||
func constraintEqual(v, c *Version) bool { |
||||
return v.Equal(c) |
||||
} |
||||
|
||||
func constraintNotEqual(v, c *Version) bool { |
||||
return !v.Equal(c) |
||||
} |
||||
|
||||
func constraintGreaterThan(v, c *Version) bool { |
||||
return prereleaseCheck(v, c) && v.Compare(c) == 1 |
||||
} |
||||
|
||||
func constraintLessThan(v, c *Version) bool { |
||||
return prereleaseCheck(v, c) && v.Compare(c) == -1 |
||||
} |
||||
|
||||
func constraintGreaterThanEqual(v, c *Version) bool { |
||||
return prereleaseCheck(v, c) && v.Compare(c) >= 0 |
||||
} |
||||
|
||||
func constraintLessThanEqual(v, c *Version) bool { |
||||
return prereleaseCheck(v, c) && v.Compare(c) <= 0 |
||||
} |
||||
|
||||
func constraintPessimistic(v, c *Version) bool { |
||||
// Using a pessimistic constraint with a pre-release, restricts versions to pre-releases
|
||||
if !prereleaseCheck(v, c) || (c.Prerelease() != "" && v.Prerelease() == "") { |
||||
return false |
||||
} |
||||
|
||||
// If the version being checked is naturally less than the constraint, then there
|
||||
// is no way for the version to be valid against the constraint
|
||||
if v.LessThan(c) { |
||||
return false |
||||
} |
||||
// We'll use this more than once, so grab the length now so it's a little cleaner
|
||||
// to write the later checks
|
||||
cs := len(c.segments) |
||||
|
||||
// If the version being checked has less specificity than the constraint, then there
|
||||
// is no way for the version to be valid against the constraint
|
||||
if cs > len(v.segments) { |
||||
return false |
||||
} |
||||
|
||||
// Check the segments in the constraint against those in the version. If the version
|
||||
// being checked, at any point, does not have the same values in each index of the
|
||||
// constraints segments, then it cannot be valid against the constraint.
|
||||
for i := 0; i < c.si-1; i++ { |
||||
if v.segments[i] != c.segments[i] { |
||||
return false |
||||
} |
||||
} |
||||
|
||||
// Check the last part of the segment in the constraint. If the version segment at
|
||||
// this index is less than the constraints segment at this index, then it cannot
|
||||
// be valid against the constraint
|
||||
if c.segments[cs-1] > v.segments[cs-1] { |
||||
return false |
||||
} |
||||
|
||||
// If nothing has rejected the version by now, it's valid
|
||||
return true |
||||
} |
||||
@ -0,0 +1 @@ |
||||
module github.com/hashicorp/go-version |
||||
@ -0,0 +1,380 @@ |
||||
package version |
||||
|
||||
import ( |
||||
"bytes" |
||||
"fmt" |
||||
"reflect" |
||||
"regexp" |
||||
"strconv" |
||||
"strings" |
||||
) |
||||
|
||||
// The compiled regular expression used to test the validity of a version.
|
||||
var ( |
||||
versionRegexp *regexp.Regexp |
||||
semverRegexp *regexp.Regexp |
||||
) |
||||
|
||||
// The raw regular expression string used for testing the validity
|
||||
// of a version.
|
||||
const ( |
||||
VersionRegexpRaw string = `v?([0-9]+(\.[0-9]+)*?)` + |
||||
`(-([0-9]+[0-9A-Za-z\-~]*(\.[0-9A-Za-z\-~]+)*)|(-?([A-Za-z\-~]+[0-9A-Za-z\-~]*(\.[0-9A-Za-z\-~]+)*)))?` + |
||||
`(\+([0-9A-Za-z\-~]+(\.[0-9A-Za-z\-~]+)*))?` + |
||||
`?` |
||||
|
||||
// SemverRegexpRaw requires a separator between version and prerelease
|
||||
SemverRegexpRaw string = `v?([0-9]+(\.[0-9]+)*?)` + |
||||
`(-([0-9]+[0-9A-Za-z\-~]*(\.[0-9A-Za-z\-~]+)*)|(-([A-Za-z\-~]+[0-9A-Za-z\-~]*(\.[0-9A-Za-z\-~]+)*)))?` + |
||||
`(\+([0-9A-Za-z\-~]+(\.[0-9A-Za-z\-~]+)*))?` + |
||||
`?` |
||||
) |
||||
|
||||
// Version represents a single version.
|
||||
type Version struct { |
||||
metadata string |
||||
pre string |
||||
segments []int64 |
||||
si int |
||||
original string |
||||
} |
||||
|
||||
func init() { |
||||
versionRegexp = regexp.MustCompile("^" + VersionRegexpRaw + "$") |
||||
semverRegexp = regexp.MustCompile("^" + SemverRegexpRaw + "$") |
||||
} |
||||
|
||||
// NewVersion parses the given version and returns a new
|
||||
// Version.
|
||||
func NewVersion(v string) (*Version, error) { |
||||
return newVersion(v, versionRegexp) |
||||
} |
||||
|
||||
// NewSemver parses the given version and returns a new
|
||||
// Version that adheres strictly to SemVer specs
|
||||
// https://semver.org/
|
||||
func NewSemver(v string) (*Version, error) { |
||||
return newVersion(v, semverRegexp) |
||||
} |
||||
|
||||
func newVersion(v string, pattern *regexp.Regexp) (*Version, error) { |
||||
matches := pattern.FindStringSubmatch(v) |
||||
if matches == nil { |
||||
return nil, fmt.Errorf("Malformed version: %s", v) |
||||
} |
||||
segmentsStr := strings.Split(matches[1], ".") |
||||
segments := make([]int64, len(segmentsStr)) |
||||
si := 0 |
||||
for i, str := range segmentsStr { |
||||
val, err := strconv.ParseInt(str, 10, 64) |
||||
if err != nil { |
||||
return nil, fmt.Errorf( |
||||
"Error parsing version: %s", err) |
||||
} |
||||
|
||||
segments[i] = int64(val) |
||||
si++ |
||||
} |
||||
|
||||
// Even though we could support more than three segments, if we
|
||||
// got less than three, pad it with 0s. This is to cover the basic
|
||||
// default usecase of semver, which is MAJOR.MINOR.PATCH at the minimum
|
||||
for i := len(segments); i < 3; i++ { |
||||
segments = append(segments, 0) |
||||
} |
||||
|
||||
pre := matches[7] |
||||
if pre == "" { |
||||
pre = matches[4] |
||||
} |
||||
|
||||
return &Version{ |
||||
metadata: matches[10], |
||||
pre: pre, |
||||
segments: segments, |
||||
si: si, |
||||
original: v, |
||||
}, nil |
||||
} |
||||
|
||||
// Must is a helper that wraps a call to a function returning (*Version, error)
|
||||
// and panics if error is non-nil.
|
||||
func Must(v *Version, err error) *Version { |
||||
if err != nil { |
||||
panic(err) |
||||
} |
||||
|
||||
return v |
||||
} |
||||
|
||||
// Compare compares this version to another version. This
|
||||
// returns -1, 0, or 1 if this version is smaller, equal,
|
||||
// or larger than the other version, respectively.
|
||||
//
|
||||
// If you want boolean results, use the LessThan, Equal,
|
||||
// GreaterThan, GreaterThanOrEqual or LessThanOrEqual methods.
|
||||
func (v *Version) Compare(other *Version) int { |
||||
// A quick, efficient equality check
|
||||
if v.String() == other.String() { |
||||
return 0 |
||||
} |
||||
|
||||
segmentsSelf := v.Segments64() |
||||
segmentsOther := other.Segments64() |
||||
|
||||
// If the segments are the same, we must compare on prerelease info
|
||||
if reflect.DeepEqual(segmentsSelf, segmentsOther) { |
||||
preSelf := v.Prerelease() |
||||
preOther := other.Prerelease() |
||||
if preSelf == "" && preOther == "" { |
||||
return 0 |
||||
} |
||||
if preSelf == "" { |
||||
return 1 |
||||
} |
||||
if preOther == "" { |
||||
return -1 |
||||
} |
||||
|
||||
return comparePrereleases(preSelf, preOther) |
||||
} |
||||
|
||||
// Get the highest specificity (hS), or if they're equal, just use segmentSelf length
|
||||
lenSelf := len(segmentsSelf) |
||||
lenOther := len(segmentsOther) |
||||
hS := lenSelf |
||||
if lenSelf < lenOther { |
||||
hS = lenOther |
||||
} |
||||