code: fix grammatical errors

fcharlie · fcharlie · commit 118dbab15bc8 · 2025-02-26T11:06:32.000+08:00
diff --git a/docs/protocol.md b/docs/protocol.md
@@ -360,7 +360,7 @@ type WantObject struct {
     OID  string `json:"oid"`
 }
 
-type BatchSharedsRequest struct {
+type BatchShareObjectsRequest struct {
     Objects []*WantObject `json:"objects"`
 }
 ```
@@ -391,7 +391,7 @@ type Representation struct {
     ExpiresAt      time.Time         `json:"expires_at,omitempty"`
 }
 
-type BatchSharedsResponse struct {
+type BatchShareObjectsResponse struct {
     Objects []*Representation `json:"objects"`
 }
 
diff --git a/modules/oss/bucket.go b/modules/oss/bucket.go
@@ -159,7 +159,7 @@ h = hmac.new(accesskey,
 Signature = base64.encodestring(h.digest()).strip()
 */
 
-func (b *bucket) Sharing(ctx context.Context, resourcePath string, expiresAt int64) string {
+func (b *bucket) Share(ctx context.Context, resourcePath string, expiresAt int64) string {
 	u := &url.URL{
 		Scheme: b.sharedScheme,
 		Host:   b.sharedBucketEndpoint,
diff --git a/modules/oss/gcs.del b/modules/oss/gcs.del
@@ -124,7 +124,7 @@ func (b *gscBucket) ListObjects(ctx context.Context, prefix, continuationToken s
 	return objects, it.PageInfo().Token, nil
 }
 
-func (b *gscBucket) Sharing(ctx context.Context, resourcePath string, expiresAt int64) string {
+func (b *gscBucket) Share(ctx context.Context, resourcePath string, expiresAt int64) string {
 	signedURL, _ := b.bucket.SignedURL(resourcePath, &storage.SignedURLOptions{Method: http.MethodGet, Expires: time.Now().Add(time.Second * time.Duration(expiresAt))})
 	return signedURL
 }
diff --git a/modules/oss/oss.go b/modules/oss/oss.go
@@ -35,7 +35,7 @@ type Bucket interface {
 	LinearUpload(ctx context.Context, resourcePath string, r io.Reader, size int64, mime string) error
 	DeleteMultipleObjects(ctx context.Context, objectKeys []string) error
 	ListObjects(ctx context.Context, prefix, continuationToken string) ([]*Object, string, error)
-	Sharing(ctx context.Context, resourcePath string, expiresAt int64) string
+	Share(ctx context.Context, resourcePath string, expiresAt int64) string
 }
 
 var (
diff --git a/modules/oss/s3.go b/modules/oss/s3.go
@@ -311,7 +311,7 @@ func (b *s3Bucket) ListObjects(ctx context.Context, prefix, continuationToken st
 	return objects, aws.ToString(out.ContinuationToken), nil
 }
 
-func (b *s3Bucket) Sharing(ctx context.Context, resourcePath string, expiresAt int64) string {
+func (b *s3Bucket) Share(ctx context.Context, resourcePath string, expiresAt int64) string {
 	o, err := b.pc.PresignGetObject(ctx, &s3.GetObjectInput{
 		Bucket: aws.String(b.bucketName),
 		Key:    aws.String(resourcePath),
diff --git a/pkg/serve/httpserver/transfer.go b/pkg/serve/httpserver/transfer.go
@@ -208,7 +208,7 @@ func (s *Server) BatchObjects(w http.ResponseWriter, r *Request) {
 
 // POST /{namespace}/{repo}/objects/share
 func (s *Server) ShareObjects(w http.ResponseWriter, r *Request) {
-	var request protocol.BatchSharedsRequest
+	var request protocol.BatchShareObjectsRequest
 	if err := json.NewDecoder(r.Body).Decode(&request); err != nil {
 		renderFailureFormat(w, r.Request, http.StatusBadRequest, "decode request body error: %v", err)
 		return
@@ -219,7 +219,7 @@ func (s *Server) ShareObjects(w http.ResponseWriter, r *Request) {
 	}
 	defer rr.Close()
 
-	response := &protocol.BatchSharedsResponse{
+	response := &protocol.BatchShareObjectsResponse{
 		Objects: make([]*protocol.Representation, 0, len(request.Objects)),
 	}
 	odb := rr.ODB()
@@ -232,7 +232,7 @@ func (s *Server) ShareObjects(w http.ResponseWriter, r *Request) {
 		}
 		want := plumbing.NewHash(o.OID)
 		// oss shared download link
-		ro, err := odb.Sharing(r.Context(), want, expiresAt)
+		ro, err := odb.Share(r.Context(), want, expiresAt)
 		if err != nil {
 			s.renderError(w, r, err)
 			return
diff --git a/pkg/serve/odb/odb.go b/pkg/serve/odb/odb.go
@@ -25,7 +25,7 @@ type DB interface {
 	Push(ctx context.Context, oid plumbing.Hash) error // Push object to OSS
 	WriteDirect(ctx context.Context, oid plumbing.Hash, r io.Reader, size int64) (int64, error)
 	Stat(ctx context.Context, oid plumbing.Hash) (*oss.Stat, error)
-	Sharing(ctx context.Context, oid plumbing.Hash, expiresAt int64) (*Representation, error)
+	Share(ctx context.Context, oid plumbing.Hash, expiresAt int64) (*Representation, error)
 }
 
 type ODB struct {
diff --git a/pkg/serve/odb/oss.go b/pkg/serve/odb/oss.go
@@ -48,7 +48,7 @@ type Representation struct {
 	ExpiresAt int64
 }
 
-func (o *ODB) Sharing(ctx context.Context, oid plumbing.Hash, expiresAt int64) (*Representation, error) {
+func (o *ODB) Share(ctx context.Context, oid plumbing.Hash, expiresAt int64) (*Representation, error) {
 	resourcePath := ossJoin(o.rid, oid)
 	si, err := o.bucket.Stat(ctx, resourcePath)
 	if err != nil {
@@ -57,7 +57,7 @@ func (o *ODB) Sharing(ctx context.Context, oid plumbing.Hash, expiresAt int64) (
 		}
 		return nil, err
 	}
-	href := o.bucket.Sharing(ctx, resourcePath, expiresAt)
+	href := o.bucket.Share(ctx, resourcePath, expiresAt)
 	return &Representation{
 		Href:      href,
 		Size:      si.Size,
diff --git a/pkg/serve/protocol/protocol.go b/pkg/serve/protocol/protocol.go
@@ -103,7 +103,7 @@ type WantObject struct {
 	Path string `json:"path,omitempty"`
 }
 
-type BatchSharedsRequest struct {
+type BatchShareObjectsRequest struct {
 	Objects []*WantObject `json:"objects"`
 }
 
@@ -115,7 +115,7 @@ type Representation struct {
 	ExpiresAt      time.Time         `json:"expires_at,omitempty"`
 }
 
-type BatchSharedsResponse struct {
+type BatchShareObjectsResponse struct {
 	Objects []*Representation `json:"objects"`
 }
 
diff --git a/pkg/serve/sshserver/command_objects.go b/pkg/serve/sshserver/command_objects.go
@@ -161,7 +161,7 @@ func (s *Server) GetObject(e *Session, oid plumbing.Hash, offset int64) int {
 }
 
 func (s *Server) ShareObjects(e *Session) int {
-	var request protocol.BatchSharedsRequest
+	var request protocol.BatchShareObjectsRequest
 	if err := json.NewDecoder(e).Decode(&request); err != nil {
 		return e.ExitFormat(400, "decode request body error: %v", err)
 	}
@@ -171,7 +171,7 @@ func (s *Server) ShareObjects(e *Session) int {
 	}
 	defer rr.Close()
 
-	response := &protocol.BatchSharedsResponse{
+	response := &protocol.BatchShareObjectsResponse{
 		Objects: make([]*protocol.Representation, 0, len(request.Objects)),
 	}
 	odb := rr.ODB()
@@ -183,7 +183,7 @@ func (s *Server) ShareObjects(e *Session) int {
 		}
 		want := plumbing.NewHash(o.OID)
 		// oss shared download link
-		ro, err := odb.Sharing(e.Context(), want, expiresAt)
+		ro, err := odb.Share(e.Context(), want, expiresAt)
 		if err != nil {
 			return e.ExitError(err)
 		}
diff --git a/pkg/transport/http/blob.go b/pkg/transport/http/blob.go
@@ -62,9 +62,9 @@ func (c *client) BatchObjects(ctx context.Context, oids []plumbing.Hash) (transp
 	}, nil
 }
 
-func (c *client) Shared(ctx context.Context, wantObjects []*transport.WantObject) ([]*transport.Representation, error) {
+func (c *client) Share(ctx context.Context, wantObjects []*transport.WantObject) ([]*transport.Representation, error) {
 	var b bytes.Buffer
-	if err := json.NewEncoder(&b).Encode(&transport.BatchSharedsRequest{
+	if err := json.NewEncoder(&b).Encode(&transport.BatchShareObjectsRequest{
 		Objects: wantObjects,
 	}); err != nil {
 		return nil, err
@@ -83,7 +83,7 @@ func (c *client) Shared(ctx context.Context, wantObjects []*transport.WantObject
 	if resp.StatusCode > 299 || resp.StatusCode < 200 {
 		return nil, parseError(resp)
 	}
-	var response transport.BatchSharedsResponse
+	var response transport.BatchShareObjectsResponse
 	if err := json.NewDecoder(resp.Body).Decode(&response); err != nil {
 		return nil, err
 	}
diff --git a/pkg/transport/ssh/objects.go b/pkg/transport/ssh/objects.go
@@ -102,11 +102,11 @@ func (c *client) GetObject(ctx context.Context, oid plumbing.Hash, fromByte int6
 	}, nil
 }
 
-// Shared: get large objects shared links
-func (c *client) Shared(ctx context.Context, wantObjects []*transport.WantObject) ([]*transport.Representation, error) {
+// Share: get large objects shared links
+func (c *client) Share(ctx context.Context, wantObjects []*transport.WantObject) ([]*transport.Representation, error) {
 	commandArgs := fmt.Sprintf("zeta-serve objects '%s' --share", c.Path)
 	var b bytes.Buffer
-	if err := json.NewEncoder(&b).Encode(&transport.BatchSharedsRequest{
+	if err := json.NewEncoder(&b).Encode(&transport.BatchShareObjectsRequest{
 		Objects: wantObjects,
 	}); err != nil {
 		return nil, err
@@ -125,7 +125,7 @@ func (c *client) Shared(ctx context.Context, wantObjects []*transport.WantObject
 		_ = cmd.Close()
 		return nil, err
 	}
-	var r transport.BatchSharedsResponse
+	var r transport.BatchShareObjectsResponse
 	if err := json.NewDecoder(stdout).Decode(&r); err != nil {
 		_ = cmd.Close()
 		return nil, cmd.lastError
diff --git a/pkg/transport/struct.go b/pkg/transport/struct.go
@@ -65,7 +65,7 @@ type WantObject struct {
 	OID string `json:"oid"`
 }
 
-type BatchSharedsRequest struct {
+type BatchShareObjectsRequest struct {
 	Objects []*WantObject `json:"objects"`
 }
 
@@ -91,7 +91,7 @@ func (r *Representation) Copy() *Representation {
 	return &Representation{OID: r.OID, CompressedSize: r.CompressedSize, Href: r.Href, Header: header, ExpiresAt: r.ExpiresAt}
 }
 
-type BatchSharedsResponse struct {
+type BatchShareObjectsResponse struct {
 	Objects []*Representation `json:"objects"`
 }
 
diff --git a/pkg/transport/transport.go b/pkg/transport/transport.go
@@ -48,8 +48,8 @@ type Transport interface {
 	BatchObjects(ctx context.Context, oids []plumbing.Hash) (SessionReader, error)
 	// GetObject: get large object, support Range feature
 	GetObject(ctx context.Context, oid plumbing.Hash, fromByte int64) (SizeReader, error)
-	// Shared: get large objects shared links
-	Shared(ctx context.Context, wantObjects []*WantObject) ([]*Representation, error)
+	// Share: get large objects shared links
+	Share(ctx context.Context, wantObjects []*WantObject) ([]*Representation, error)
 	// Push: push metadata and blobs to remote and update reference
 	Push(ctx context.Context, r io.Reader, cmd *Command) (rc SessionReader, err error)
 	// BatchCheck: check large objects exists in remote
diff --git a/pkg/zeta/transfer.go b/pkg/zeta/transfer.go
@@ -43,7 +43,7 @@ func (r *Repository) getLinks(ctx context.Context, t transport.Transport, larges
 	if len(wantObjects) == 0 {
 		return nil, nil
 	}
-	objects, err := t.Shared(ctx, wantObjects)
+	objects, err := t.Share(ctx, wantObjects)
 	if err != nil {
 		fmt.Fprintf(os.Stderr, "batch shared response error: %v\n", err)
 		return nil, err

Original file line number	Diff line number	Diff line change
`@@ -360,7 +360,7 @@ type WantObject struct {`
`360`	`360`	OID string `json:"oid"`
`361`	`361`	`}`
`362`	`362`
`363`		`-type BatchSharedsRequest struct {`
	`363`	`+type BatchShareObjectsRequest struct {`
`364`	`364`	Objects []*WantObject `json:"objects"`
`365`	`365`	`}`
`366`	`366`	```
`@@ -391,7 +391,7 @@ type Representation struct {`
`391`	`391`	ExpiresAt time.Time `json:"expires_at,omitempty"`
`392`	`392`	`}`
`393`	`393`
`394`		`-type BatchSharedsResponse struct {`
	`394`	`+type BatchShareObjectsResponse struct {`
`395`	`395`	Objects []*Representation `json:"objects"`
`396`	`396`	`}`
`397`	`397`
Original file line number	Diff line number	Diff line change
`@@ -124,7 +124,7 @@ func (b *gscBucket) ListObjects(ctx context.Context, prefix, continuationToken s`
`124`	`124`	`return objects, it.PageInfo().Token, nil`
`125`	`125`	`}`
`126`	`126`
`127`		`-func (b *gscBucket) Sharing(ctx context.Context, resourcePath string, expiresAt int64) string {`
	`127`	`+func (b *gscBucket) Share(ctx context.Context, resourcePath string, expiresAt int64) string {`
`128`	`128`	`signedURL, _ := b.bucket.SignedURL(resourcePath, &storage.SignedURLOptions{Method: http.MethodGet, Expires: time.Now().Add(time.Second * time.Duration(expiresAt))})`
`129`	`129`	`return signedURL`
`130`	`130`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ type Bucket interface {`
`35`	`35`	`LinearUpload(ctx context.Context, resourcePath string, r io.Reader, size int64, mime string) error`
`36`	`36`	`DeleteMultipleObjects(ctx context.Context, objectKeys []string) error`
`37`	`37`	`ListObjects(ctx context.Context, prefix, continuationToken string) ([]*Object, string, error)`
`38`		`- Sharing(ctx context.Context, resourcePath string, expiresAt int64) string`
	`38`	`+ Share(ctx context.Context, resourcePath string, expiresAt int64) string`
`39`	`39`	`}`
`40`	`40`
`41`	`41`	`var (`
Original file line number	Diff line number	Diff line change
`@@ -311,7 +311,7 @@ func (b *s3Bucket) ListObjects(ctx context.Context, prefix, continuationToken st`
`311`	`311`	`return objects, aws.ToString(out.ContinuationToken), nil`
`312`	`312`	`}`
`313`	`313`
`314`		`-func (b *s3Bucket) Sharing(ctx context.Context, resourcePath string, expiresAt int64) string {`
	`314`	`+func (b *s3Bucket) Share(ctx context.Context, resourcePath string, expiresAt int64) string {`
`315`	`315`	`o, err := b.pc.PresignGetObject(ctx, &s3.GetObjectInput{`
`316`	`316`	`Bucket: aws.String(b.bucketName),`
`317`	`317`	`Key: aws.String(resourcePath),`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ type DB interface {`
`25`	`25`	`Push(ctx context.Context, oid plumbing.Hash) error // Push object to OSS`
`26`	`26`	`WriteDirect(ctx context.Context, oid plumbing.Hash, r io.Reader, size int64) (int64, error)`
`27`	`27`	`Stat(ctx context.Context, oid plumbing.Hash) (*oss.Stat, error)`
`28`		`- Sharing(ctx context.Context, oid plumbing.Hash, expiresAt int64) (*Representation, error)`
	`28`	`+ Share(ctx context.Context, oid plumbing.Hash, expiresAt int64) (*Representation, error)`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`type ODB struct {`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ type Representation struct {`
`48`	`48`	`ExpiresAt int64`
`49`	`49`	`}`
`50`	`50`
`51`		`-func (o ODB) Sharing(ctx context.Context, oid plumbing.Hash, expiresAt int64) (Representation, error) {`
	`51`	`+func (o ODB) Share(ctx context.Context, oid plumbing.Hash, expiresAt int64) (Representation, error) {`
`52`	`52`	`resourcePath := ossJoin(o.rid, oid)`
`53`	`53`	`si, err := o.bucket.Stat(ctx, resourcePath)`
`54`	`54`	`if err != nil {`
`@@ -57,7 +57,7 @@ func (o *ODB) Sharing(ctx context.Context, oid plumbing.Hash, expiresAt int64) (`
`57`	`57`	`}`
`58`	`58`	`return nil, err`
`59`	`59`	`}`
`60`		`- href := o.bucket.Sharing(ctx, resourcePath, expiresAt)`
	`60`	`+ href := o.bucket.Share(ctx, resourcePath, expiresAt)`
`61`	`61`	`return &Representation{`
`62`	`62`	`Href: href,`
`63`	`63`	`Size: si.Size,`
Original file line number	Diff line number	Diff line change
`@@ -103,7 +103,7 @@ type WantObject struct {`
`103`	`103`	Path string `json:"path,omitempty"`
`104`	`104`	`}`
`105`	`105`
`106`		`-type BatchSharedsRequest struct {`
	`106`	`+type BatchShareObjectsRequest struct {`
`107`	`107`	Objects []*WantObject `json:"objects"`
`108`	`108`	`}`
`109`	`109`
`@@ -115,7 +115,7 @@ type Representation struct {`
`115`	`115`	ExpiresAt time.Time `json:"expires_at,omitempty"`
`116`	`116`	`}`
`117`	`117`
`118`		`-type BatchSharedsResponse struct {`
	`118`	`+type BatchShareObjectsResponse struct {`
`119`	`119`	Objects []*Representation `json:"objects"`
`120`	`120`	`}`
`121`	`121`
Original file line number	Diff line number	Diff line change
`@@ -161,7 +161,7 @@ func (s Server) GetObject(e Session, oid plumbing.Hash, offset int64) int {`
`161`	`161`	`}`
`162`	`162`
`163`	`163`	`func (s Server) ShareObjects(e Session) int {`
`164`		`- var request protocol.BatchSharedsRequest`
	`164`	`+ var request protocol.BatchShareObjectsRequest`
`165`	`165`	`if err := json.NewDecoder(e).Decode(&request); err != nil {`
`166`	`166`	`return e.ExitFormat(400, "decode request body error: %v", err)`
`167`	`167`	`}`
`@@ -171,7 +171,7 @@ func (s Server) ShareObjects(e Session) int {`
`171`	`171`	`}`
`172`	`172`	`defer rr.Close()`
`173`	`173`
`174`		`- response := &protocol.BatchSharedsResponse{`
	`174`	`+ response := &protocol.BatchShareObjectsResponse{`
`175`	`175`	`Objects: make([]*protocol.Representation, 0, len(request.Objects)),`
`176`	`176`	`}`
`177`	`177`	`odb := rr.ODB()`
`@@ -183,7 +183,7 @@ func (s Server) ShareObjects(e Session) int {`
`183`	`183`	`}`
`184`	`184`	`want := plumbing.NewHash(o.OID)`
`185`	`185`	`// oss shared download link`
`186`		`- ro, err := odb.Sharing(e.Context(), want, expiresAt)`
	`186`	`+ ro, err := odb.Share(e.Context(), want, expiresAt)`
`187`	`187`	`if err != nil {`
`188`	`188`	`return e.ExitError(err)`
`189`	`189`	`}`