Merge branch 'integration'

This commit is contained in:
JBP
2019-08-17 18:21:13 +02:00
11 changed files with 558 additions and 231 deletions

View File

@@ -8,12 +8,12 @@ import (
"time" "time"
) )
// BrowseService handles communication with the Browse API // BrowseService handles communication with the Browse API.
// //
// eBay API docs: https://developer.ebay.com/api-docs/buy/browse/overview.html // eBay API docs: https://developer.ebay.com/api-docs/buy/browse/overview.html
type BrowseService service type BrowseService service
// Valid values of the "buyingOptions" array for items. // Valid values for the "buyingOptions" item field.
const ( const (
BrowseBuyingOptionAuction = "AUCTION" BrowseBuyingOptionAuction = "AUCTION"
BrowseBuyingOptionFixedPrice = "FIXED_PRICE" BrowseBuyingOptionFixedPrice = "FIXED_PRICE"
@@ -160,7 +160,7 @@ type LegacyItem struct {
// eBay API docs: https://developer.ebay.com/api-docs/buy/browse/resources/item/methods/getItemByLegacyId // eBay API docs: https://developer.ebay.com/api-docs/buy/browse/resources/item/methods/getItemByLegacyId
func (s *BrowseService) GetItemByLegacyID(ctx context.Context, itemLegacyID string, opts ...Opt) (CompactItem, error) { func (s *BrowseService) GetItemByLegacyID(ctx context.Context, itemLegacyID string, opts ...Opt) (CompactItem, error) {
u := fmt.Sprintf("buy/browse/v1/item/get_item_by_legacy_id?legacy_item_id=%s", itemLegacyID) u := fmt.Sprintf("buy/browse/v1/item/get_item_by_legacy_id?legacy_item_id=%s", itemLegacyID)
req, err := s.client.NewRequest(http.MethodGet, u, opts...) req, err := s.client.NewRequest(http.MethodGet, u, nil, opts...)
if err != nil { if err != nil {
return CompactItem{}, err return CompactItem{}, err
} }
@@ -190,7 +190,7 @@ type CompactItem struct {
// eBay API docs: https://developer.ebay.com/api-docs/buy/browse/resources/item/methods/getItem // eBay API docs: https://developer.ebay.com/api-docs/buy/browse/resources/item/methods/getItem
func (s *BrowseService) GetCompactItem(ctx context.Context, itemID string, opts ...Opt) (CompactItem, error) { func (s *BrowseService) GetCompactItem(ctx context.Context, itemID string, opts ...Opt) (CompactItem, error) {
u := fmt.Sprintf("buy/browse/v1/item/%s?fieldgroups=COMPACT", itemID) u := fmt.Sprintf("buy/browse/v1/item/%s?fieldgroups=COMPACT", itemID)
req, err := s.client.NewRequest(http.MethodGet, u, opts...) req, err := s.client.NewRequest(http.MethodGet, u, nil, opts...)
if err != nil { if err != nil {
return CompactItem{}, err return CompactItem{}, err
} }
@@ -368,7 +368,7 @@ type Item struct {
// eBay API docs: https://developer.ebay.com/api-docs/buy/browse/resources/item/methods/getItem // eBay API docs: https://developer.ebay.com/api-docs/buy/browse/resources/item/methods/getItem
func (s *BrowseService) GetItem(ctx context.Context, itemID string, opts ...Opt) (Item, error) { func (s *BrowseService) GetItem(ctx context.Context, itemID string, opts ...Opt) (Item, error) {
u := fmt.Sprintf("buy/browse/v1/item/%s?fieldgroups=PRODUCT", itemID) u := fmt.Sprintf("buy/browse/v1/item/%s?fieldgroups=PRODUCT", itemID)
req, err := s.client.NewRequest(http.MethodGet, u, opts...) req, err := s.client.NewRequest(http.MethodGet, u, nil, opts...)
if err != nil { if err != nil {
return Item{}, err return Item{}, err
} }

View File

@@ -28,6 +28,9 @@ func TestGetLegacyItem(t *testing.T) {
defer teardown() defer teardown()
mux.HandleFunc("/buy/browse/v1/item/get_item_by_legacy_id", func(w http.ResponseWriter, r *http.Request) { mux.HandleFunc("/buy/browse/v1/item/get_item_by_legacy_id", func(w http.ResponseWriter, r *http.Request) {
if r.Method != "GET" {
t.Fatalf("expected GET method, got: %s", r.Method)
}
fmt.Fprintf(w, `{"itemId": "v1|%s|0"}`, r.URL.Query().Get("legacy_item_id")) fmt.Fprintf(w, `{"itemId": "v1|%s|0"}`, r.URL.Query().Get("legacy_item_id"))
}) })
@@ -41,6 +44,9 @@ func TestGetCompactItem(t *testing.T) {
defer teardown() defer teardown()
mux.HandleFunc("/buy/browse/v1/item/v1|202117468662|0", func(w http.ResponseWriter, r *http.Request) { mux.HandleFunc("/buy/browse/v1/item/v1|202117468662|0", func(w http.ResponseWriter, r *http.Request) {
if r.Method != "GET" {
t.Fatalf("expected GET method, got: %s", r.Method)
}
fmt.Fprintf(w, `{"itemId": "%s"}`, r.URL.Query().Get("fieldgroups")) fmt.Fprintf(w, `{"itemId": "%s"}`, r.URL.Query().Get("fieldgroups"))
}) })
@@ -54,6 +60,9 @@ func TestGettItem(t *testing.T) {
defer teardown() defer teardown()
mux.HandleFunc("/buy/browse/v1/item/v1|202117468662|0", func(w http.ResponseWriter, r *http.Request) { mux.HandleFunc("/buy/browse/v1/item/v1|202117468662|0", func(w http.ResponseWriter, r *http.Request) {
if r.Method != "GET" {
t.Fatalf("expected GET method, got: %s", r.Method)
}
fmt.Fprintf(w, `{"itemId": "%s"}`, r.URL.Query().Get("fieldgroups")) fmt.Fprintf(w, `{"itemId": "%s"}`, r.URL.Query().Get("fieldgroups"))
}) })

View File

@@ -1,121 +0,0 @@
// Package clientcredentials implements the eBay client credentials grant flow
// to generate "Application access" tokens.
// eBay doc: https://developer.ebay.com/api-docs/static/oauth-client-credentials-grant.html
//
// The only difference from the original golang.org/x/oauth2/clientcredentials is the token type
// being forced to "Bearer". The eBay api /identity/v1/oauth2/token endpoint returns
// "Application Access Token" as token type which is then reused:
// https://github.com/golang/oauth2/blob/aaccbc9213b0974828f81aaac109d194880e3014/token.go#L68-L70
package clientcredentials
import (
"bytes"
"context"
"encoding/json"
"fmt"
"io/ioutil"
"net/http"
"net/url"
"strings"
"time"
"golang.org/x/oauth2"
)
type Config struct {
// ClientID is the application's ID.
ClientID string
// ClientSecret is the application's secret.
ClientSecret string
// TokenURL is the resource server's token endpoint
// URL. This is a constant specific to each server.
TokenURL string
// Scope specifies optional requested permissions.
Scopes []string
// HTTPClient used to make requests.
HTTPClient *http.Client
}
// Token uses client credentials to retrieve a token.
func (c *Config) Token(ctx context.Context) (*oauth2.Token, error) {
return c.TokenSource(ctx).Token()
}
// Client returns an HTTP client using the provided token.
// The token will auto-refresh as necessary.
// The returned client and its Transport should not be modified.
func (c *Config) Client(ctx context.Context) *http.Client {
return oauth2.NewClient(ctx, c.TokenSource(ctx))
}
// TokenSource returns a TokenSource that returns t until t expires,
// automatically refreshing it as necessary using the provided context and the
// client ID and client secret.
//
// Most users will use Config.Client instead.
func (c *Config) TokenSource(ctx context.Context) oauth2.TokenSource {
source := &tokenSource{
ctx: ctx,
conf: c,
}
return oauth2.ReuseTokenSource(nil, source)
}
type tokenSource struct {
ctx context.Context
conf *Config
}
// Token refreshes the token by using a new client credentials request.
// tokens received this way do not include a refresh token
func (c *tokenSource) Token() (*oauth2.Token, error) {
v := url.Values{
"grant_type": {"client_credentials"},
}
if len(c.conf.Scopes) > 0 {
v.Set("scope", strings.Join(c.conf.Scopes, " "))
}
req, err := http.NewRequest("POST", c.conf.TokenURL, strings.NewReader(v.Encode()))
if err != nil {
return nil, err
}
req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
req.SetBasicAuth(url.QueryEscape(c.conf.ClientID), url.QueryEscape(c.conf.ClientSecret))
client := c.conf.HTTPClient
if client == nil {
client = http.DefaultClient
}
r, err := client.Do(req)
if err != nil {
return nil, err
}
defer r.Body.Close()
body, err := ioutil.ReadAll(r.Body)
if err != nil {
return nil, fmt.Errorf("cannot fetch token: %v", err)
}
if code := r.StatusCode; code < 200 || code > 299 {
return nil, fmt.Errorf("%s (%d)", req.URL, r.StatusCode)
}
token := struct {
AccessToken string `json:"access_token"`
ExpiresIn int `json:"expires_in"`
}{}
if err = json.NewDecoder(bytes.NewReader(body)).Decode(&token); err != nil {
return nil, err
}
var expiry time.Time
if secs := token.ExpiresIn; secs > 0 {
expiry = time.Now().Add(time.Duration(secs) * time.Second)
}
t := oauth2.Token{
AccessToken: token.AccessToken,
Expiry: expiry,
TokenType: "Bearer",
}
return &t, nil
}

87
ebay.go
View File

@@ -1,10 +1,13 @@
package ebay package ebay
import ( import (
"bytes"
"context" "context"
"encoding/json" "encoding/json"
"fmt" "fmt"
"io"
"net/http" "net/http"
"net/http/httputil"
"net/url" "net/url"
"strings" "strings"
@@ -77,7 +80,7 @@ type Opt func(*http.Request)
// NewRequest creates an API request. // NewRequest creates an API request.
// url should always be specified without a preceding slash. // url should always be specified without a preceding slash.
func (c *Client) NewRequest(method, url string, opts ...Opt) (*http.Request, error) { func (c *Client) NewRequest(method, url string, body interface{}, opts ...Opt) (*http.Request, error) {
if strings.HasPrefix(url, "/") { if strings.HasPrefix(url, "/") {
return nil, errors.New("url should always be specified without a preceding slash") return nil, errors.New("url should always be specified without a preceding slash")
} }
@@ -85,7 +88,17 @@ func (c *Client) NewRequest(method, url string, opts ...Opt) (*http.Request, err
if err != nil { if err != nil {
return nil, errors.WithStack(err) return nil, errors.WithStack(err)
} }
req, err := http.NewRequest(method, u.String(), nil) var buf io.ReadWriter
if body != nil {
buf = new(bytes.Buffer)
enc := json.NewEncoder(buf)
enc.SetEscapeHTML(false)
if err := enc.Encode(body); err != nil {
return nil, err
}
}
req, err := http.NewRequest(method, u.String(), buf)
if err != nil { if err != nil {
return nil, errors.WithStack(err) return nil, errors.WithStack(err)
} }
@@ -102,7 +115,7 @@ func (c *Client) Do(ctx context.Context, req *http.Request, v interface{}) error
return errors.WithStack(err) return errors.WithStack(err)
} }
defer resp.Body.Close() defer resp.Body.Close()
if err := CheckResponse(resp); err != nil { if err := CheckResponse(req, resp); err != nil {
return err return err
} }
if v == nil { if v == nil {
@@ -111,38 +124,66 @@ func (c *Client) Do(ctx context.Context, req *http.Request, v interface{}) error
return errors.WithStack(json.NewDecoder(resp.Body).Decode(v)) return errors.WithStack(json.NewDecoder(resp.Body).Decode(v))
} }
// An ErrorData reports one or more errors caused by an API request. // Error describes one error caused by an eBay API request.
//
// eBay API docs: https://developer.ebay.com/api-docs/static/handling-error-messages.html
type Error struct {
ErrorID int `json:"errorId,omitempty"`
Domain string `json:"domain,omitempty"`
SubDomain string `json:"subDomain,omitempty"`
Category string `json:"category,omitempty"`
Message string `json:"message,omitempty"`
LongMessage string `json:"longMessage,omitempty"`
InputRefIds []string `json:"inputRefIds,omitempty"`
OuputRefIds []string `json:"outputRefIds,omitempty"`
Parameters []struct {
Name string `json:"name,omitempty"`
Value string `json:"value,omitempty"`
} `json:"parameters,omitempty"`
}
// ErrorData describes one or more errors caused by an eBay API request.
// //
// eBay API docs: https://developer.ebay.com/api-docs/static/handling-error-messages.html // eBay API docs: https://developer.ebay.com/api-docs/static/handling-error-messages.html
type ErrorData struct { type ErrorData struct {
Errors []struct { Errors []Error `json:"errors,omitempty"`
ErrorID int `json:"errorId,omitempty"`
Domain string `json:"domain,omitempty"` response *http.Response
SubDomain string `json:"subDomain,omitempty"` requestDump string
Category string `json:"category,omitempty"`
Message string `json:"message,omitempty"`
LongMessage string `json:"longMessage,omitempty"`
InputRefIds []string `json:"inputRefIds,omitempty"`
OuputRefIds []string `json:"outputRefIds,omitempty"`
Parameters []struct {
Name string `json:"name,omitempty"`
Value string `json:"value,omitempty"`
} `json:"parameters,omitempty"`
} `json:"errors,omitempty"`
Response *http.Response
} }
func (e *ErrorData) Error() string { func (e *ErrorData) Error() string {
return fmt.Sprintf("%s %s: %d %+v", e.Response.Request.Method, e.Response.Request.URL, return fmt.Sprintf("%d\n%s\n%+v", e.response.StatusCode, e.requestDump, e.Errors)
e.Response.StatusCode, e.Errors)
} }
// CheckResponse checks the API response for errors, and returns them if present. // CheckResponse checks the API response for errors, and returns them if present.
func CheckResponse(resp *http.Response) error { func CheckResponse(req *http.Request, resp *http.Response) error {
if s := resp.StatusCode; 200 <= s && s < 300 { if s := resp.StatusCode; 200 <= s && s < 300 {
return nil return nil
} }
errorData := &ErrorData{Response: resp} dump, _ := httputil.DumpRequest(req, true)
errorData := &ErrorData{response: resp, requestDump: string(dump)}
_ = json.NewDecoder(resp.Body).Decode(errorData) _ = json.NewDecoder(resp.Body).Decode(errorData)
return errorData return errorData
} }
// IsError allows to check if err contains specific error codes returned by the eBay API.
//
// eBay API docs: https://developer.ebay.com/devzone/xml/docs/Reference/ebay/Errors/errormessages.htm
func IsError(err error, codes ...int) bool {
if err == nil {
return false
}
errData, ok := err.(*ErrorData)
if !ok {
return false
}
for _, e := range errData.Errors {
for _, code := range codes {
if e.ErrorID == code {
return true
}
}
}
return false
}

View File

@@ -6,25 +6,39 @@ import (
"io/ioutil" "io/ioutil"
"net/http" "net/http"
"net/http/httptest" "net/http/httptest"
"net/url"
"testing" "testing"
"github.com/jybp/ebay" "github.com/jybp/ebay"
"github.com/pkg/errors"
"github.com/stretchr/testify/assert" "github.com/stretchr/testify/assert"
) )
// setup sets up a test HTTP server.
func setup(t *testing.T) (client *ebay.Client, mux *http.ServeMux, teardown func()) {
mux = http.NewServeMux()
server := httptest.NewServer(mux)
var err error
client, err = ebay.NewCustomClient(nil, server.URL+"/")
if err != nil {
t.Fatal(err)
}
return client, mux, server.Close
}
func TestNewRequest(t *testing.T) { func TestNewRequest(t *testing.T) {
testOpt := func(r *http.Request) { testOpt := func(r *http.Request) {
r.URL.RawQuery = "q=1" r.URL.RawQuery = "q=1"
} }
client, _ := ebay.NewCustomClient(nil, "https://api.ebay.com/") client, _ := ebay.NewCustomClient(nil, "https://api.ebay.com/")
r, _ := client.NewRequest(http.MethodPost, "test", testOpt) r, _ := client.NewRequest(http.MethodPost, "test", nil, testOpt)
assert.Equal(t, "https://api.ebay.com/test?q=1", fmt.Sprint(r.URL)) assert.Equal(t, "https://api.ebay.com/test?q=1", fmt.Sprint(r.URL))
assert.Equal(t, http.MethodPost, r.Method) assert.Equal(t, http.MethodPost, r.Method)
} }
func TestCheckResponseNoError(t *testing.T) { func TestCheckResponseNoError(t *testing.T) {
resp := &http.Response{StatusCode: 200} resp := &http.Response{StatusCode: 200}
assert.Nil(t, ebay.CheckResponse(resp)) assert.Nil(t, ebay.CheckResponse(&http.Request{}, resp))
} }
func TestCheckResponse(t *testing.T) { func TestCheckResponse(t *testing.T) {
@@ -53,7 +67,7 @@ func TestCheckResponse(t *testing.T) {
] ]
}` }`
resp := &http.Response{StatusCode: 400, Body: ioutil.NopCloser(bytes.NewBufferString(body))} resp := &http.Response{StatusCode: 400, Body: ioutil.NopCloser(bytes.NewBufferString(body))}
err, ok := ebay.CheckResponse(resp).(*ebay.ErrorData) err, ok := ebay.CheckResponse(&http.Request{URL: &url.URL{}}, resp).(*ebay.ErrorData)
assert.True(t, ok) assert.True(t, ok)
assert.Equal(t, 1, len(err.Errors)) assert.Equal(t, 1, len(err.Errors))
assert.Equal(t, 15008, err.Errors[0].ErrorID) assert.Equal(t, 15008, err.Errors[0].ErrorID)
@@ -68,14 +82,29 @@ func TestCheckResponse(t *testing.T) {
assert.Equal(t, "2200077988|0", err.Errors[0].Parameters[0].Value) assert.Equal(t, "2200077988|0", err.Errors[0].Parameters[0].Value)
} }
// setup sets up a test HTTP server func TestIsErrorMatches(t *testing.T) {
func setup(t *testing.T) (client *ebay.Client, mux *http.ServeMux, teardown func()) { var err error = &ebay.ErrorData{
mux = http.NewServeMux() Errors: []ebay.Error{
server := httptest.NewServer(mux) ebay.Error{ErrorID: 1},
var err error },
client, err = ebay.NewCustomClient(nil, server.URL+"/")
if err != nil {
t.Fatal(err)
} }
return client, mux, server.Close assert.True(t, ebay.IsError(err, 1, 2, 3))
}
func TestIsErrorNoMatches(t *testing.T) {
var err error = &ebay.ErrorData{
Errors: []ebay.Error{
ebay.Error{ErrorID: 4},
},
}
assert.False(t, ebay.IsError(err, 1, 2, 3))
}
func TestIsErrorWrongType(t *testing.T) {
var err error = errors.New("test")
assert.False(t, ebay.IsError(err, 1, 2, 3))
}
func TestIsErrorNil(t *testing.T) {
assert.False(t, ebay.IsError(nil, 1, 2, 3))
} }

24
oauth2.go Normal file
View File

@@ -0,0 +1,24 @@
package ebay
import "golang.org/x/oauth2"
// BearerTokenSource forces the type of the token returned by the 'base' TokenSource to 'Bearer'.
// The eBay API will return "Application Access Token" or "User Access Token" as token_type but
// it must be set to 'Bearer' for subsequent requests.
type BearerTokenSource struct {
base oauth2.TokenSource
}
// TokenSource returns a new BearerTokenSource.
func TokenSource(base oauth2.TokenSource) *BearerTokenSource {
return &BearerTokenSource{base: base}
}
// Token allows BearerTokenSource to implement oauth2.TokenSource.
func (ts *BearerTokenSource) Token() (*oauth2.Token, error) {
t, err := ts.base.Token()
if t != nil {
t.TokenType = "Bearer"
}
return t, err
}

115
offer.go
View File

@@ -1,7 +1,10 @@
package ebay package ebay
import ( import (
"context"
"fmt"
"net/http" "net/http"
"time"
) )
// OfferService handles communication with the Offer API // OfferService handles communication with the Offer API
@@ -22,6 +25,11 @@ const (
BuyMarketplaceUSA = "EBAY_US" BuyMarketplaceUSA = "EBAY_US"
) )
// Valid values for the "auctionStatus" Bidding field.
const (
BiddingAuctionStatusEnded = "ENDED"
)
// OptBuyMarketplace adds the header containing the marketplace id: // OptBuyMarketplace adds the header containing the marketplace id:
// https://developer.ebay.com/api-docs/buy/static/ref-marketplace-supported.html // https://developer.ebay.com/api-docs/buy/static/ref-marketplace-supported.html
// //
@@ -31,3 +39,110 @@ func OptBuyMarketplace(marketplaceID string) func(*http.Request) {
req.Header.Set("X-EBAY-C-MARKETPLACE-ID", marketplaceID) req.Header.Set("X-EBAY-C-MARKETPLACE-ID", marketplaceID)
} }
} }
// Bidding represents an eBay item bidding.
type Bidding struct {
AuctionStatus string `json:"auctionStatus"`
AuctionEndDate time.Time `json:"auctionEndDate"`
ItemID string `json:"itemId"`
CurrentPrice struct {
Value string `json:"value"`
Currency string `json:"currency"`
} `json:"currentPrice"`
BidCount int `json:"bidCount"`
HighBidder bool `json:"highBidder"`
ReservePriceMet bool `json:"reservePriceMet"`
SuggestedBidAmounts []struct {
Value string `json:"value"`
Currency string `json:"currency"`
} `json:"suggestedBidAmounts"`
CurrentProxyBid struct {
ProxyBidID string `json:"proxyBidId"`
MaxAmount struct {
Value string `json:"value"`
Currency string `json:"currency"`
} `json:"maxAmount"`
} `json:"currentProxyBid"`
}
// Some valid eBay error codes for the GetBidding method.
//
// eBay API docs: https://developer.ebay.com/api-docs/buy/offer/resources/bidding/methods/getBidding#h2-error-codes
const (
ErrGetBiddingMarketplaceNotSupported = 120017
ErrGetBiddingNoBiddingActivity = 120033
)
// GetBidding retrieves the buyer's bidding details on a specific auction item.
//
// eBay API docs: https://developer.ebay.com/api-docs/buy/offer/resources/bidding/methods/getBidding
func (s *OfferService) GetBidding(ctx context.Context, itemID, marketplaceID string, opts ...Opt) (Bidding, error) {
u := fmt.Sprintf("buy/offer/v1_beta/bidding/%s", itemID)
opts = append(opts, OptBuyMarketplace(marketplaceID))
req, err := s.client.NewRequest(http.MethodGet, u, nil, opts...)
if err != nil {
return Bidding{}, err
}
var bid Bidding
return bid, s.client.Do(ctx, req, &bid)
}
// ProxyBid represents an eBay proxy bid.
type ProxyBid struct {
ProxyBidID string `json:"proxyBidId"`
}
// Some valid eBay error codes for the PlaceProxyBid method.
//
// eBay API docs: https://developer.ebay.com/api-docs/buy/offer/resources/bidding/methods/placeProxyBid#h2-error-codes
const (
ErrPlaceProxyBidAuctionEndedBecauseOfBuyItNow = 120002
ErrPlaceProxyBidBidCannotBeGreaterThanBuyItNowPrice = 120005
ErrPlaceProxyBidAmountTooHigh = 120007
ErrPlaceProxyBidAmountTooLow = 120008
ErrPlaceProxyBidCurrencyMustMatchItemPriceCurrency = 120009
ErrPlaceProxyBidCannotLowerYourProxyBid = 120010
ErrPlaceProxyBidAmountExceedsLimit = 120011
ErrPlaceProxyBidAuctionHasEnded = 120012
ErrPlaceProxyBidAmountInvalid = 120013
ErrPlaceProxyBidCurrencyInvalid = 120014
ErrPlaceProxyBidMaximumBidAmountMissing = 120016
)
// PlaceProxyBid places a proxy bid for the buyer on a specific auction item.
//
// Curency is the three-letter ISO 4217 code representing the currency.
// For one hundred US dollars, MaxAmout is "100.00" and currency is "USD".
//
// You must ensure the user agrees to the "Terms of use for Adult Only category"
// (https://signin.ebay.com/ws/eBayISAPI.dll?AdultSignIn2) if he wishes to bid on on a adult-only item.
// An item is adult-only if the AdultOnly field returned by the Browse API is set to true.
//
// eBay API docs: https://developer.ebay.com/api-docs/buy/offer/resources/bidding/methods/placeProxyBid
func (s *OfferService) PlaceProxyBid(ctx context.Context, itemID, marketplaceID, maxAmount, currency string, userConsentAdultOnlyItem bool, opts ...Opt) (ProxyBid, error) {
u := fmt.Sprintf("buy/offer/v1_beta/bidding/%s/place_proxy_bid", itemID)
opts = append(opts, OptBuyMarketplace(marketplaceID))
type userConsent struct {
AdultOnlyItem bool `json:"adultOnlyItem,omitempty"`
}
type amount struct {
Currency string `json:"currency"`
Value string `json:"value"`
}
type payload struct {
MaxAmount amount `json:"maxAmount"`
UserConsent *userConsent `json:"userConsent,omitempty"`
}
pl := payload{
MaxAmount: amount{Currency: currency, Value: maxAmount},
}
if userConsentAdultOnlyItem {
pl.UserConsent = &userConsent{userConsentAdultOnlyItem}
}
req, err := s.client.NewRequest(http.MethodPost, u, &pl, opts...)
if err != nil {
return ProxyBid{}, err
}
var bid ProxyBid
return bid, s.client.Do(ctx, req, &bid)
}

View File

@@ -1,7 +1,11 @@
package ebay_test package ebay_test
import ( import (
"context"
"fmt"
"io/ioutil"
"net/http" "net/http"
"strconv"
"testing" "testing"
"github.com/jybp/ebay" "github.com/jybp/ebay"
@@ -13,3 +17,49 @@ func TestOptBuyMarketplace(t *testing.T) {
ebay.OptBuyMarketplace("EBAY_US")(r) ebay.OptBuyMarketplace("EBAY_US")(r)
assert.Equal(t, "EBAY_US", r.Header.Get("X-EBAY-C-MARKETPLACE-ID")) assert.Equal(t, "EBAY_US", r.Header.Get("X-EBAY-C-MARKETPLACE-ID"))
} }
func TestGetBidding(t *testing.T) {
client, mux, teardown := setup(t)
defer teardown()
mux.HandleFunc("/buy/offer/v1_beta/bidding/v1|202117468662|0", func(w http.ResponseWriter, r *http.Request) {
if r.Method != "GET" {
t.Fatalf("expected GET method, got: %s", r.Method)
}
marketplaceID := r.Header.Get("X-EBAY-C-MARKETPLACE-ID")
fmt.Fprintf(w, `{"itemId": "%s"}`, marketplaceID)
})
bidding, err := client.Buy.Offer.GetBidding(context.Background(), "v1|202117468662|0", ebay.BuyMarketplaceUSA)
assert.Nil(t, err)
assert.Equal(t, ebay.BuyMarketplaceUSA, bidding.ItemID)
}
func TestPlaceProxyBid(t *testing.T) {
client, mux, teardown := setup(t)
defer teardown()
mux.HandleFunc("/buy/offer/v1_beta/bidding/v1|202117468662|0/place_proxy_bid", func(w http.ResponseWriter, r *http.Request) {
if r.Method != "POST" {
t.Fatalf("expected POST method, got: %s", r.Method)
}
marketplaceID := r.Header.Get("X-EBAY-C-MARKETPLACE-ID")
body, err := ioutil.ReadAll(r.Body)
if err != nil {
t.Fatalf("%+v", err)
http.Error(w, err.Error(), 500)
return
}
escapedBody := strconv.Quote(string(body))
escapedBody = escapedBody[1 : len(escapedBody)-1]
fmt.Fprintf(w, `{"proxyBidId": "%s_%s"}`, escapedBody, marketplaceID)
})
bid, err := client.Buy.Offer.PlaceProxyBid(context.Background(), "v1|202117468662|0", ebay.BuyMarketplaceUSA, "1.23", "USD", false)
assert.Nil(t, err)
assert.Equal(t, "{\"maxAmount\":{\"currency\":\"USD\",\"value\":\"1.23\"}}\n_EBAY_US", bid.ProxyBidID)
bid, err = client.Buy.Offer.PlaceProxyBid(context.Background(), "v1|202117468662|0", ebay.BuyMarketplaceUSA, "1.23", "USD", true)
assert.Nil(t, err)
assert.Equal(t, "{\"maxAmount\":{\"currency\":\"USD\",\"value\":\"1.23\"},\"userConsent\":{\"adultOnlyItem\":true}}\n_EBAY_US", bid.ProxyBidID)
}

View File

@@ -0,0 +1,163 @@
package integration
import (
"context"
"crypto/rand"
"flag"
"fmt"
"io"
"net/http"
"net/url"
"os"
"strconv"
"strings"
"testing"
"time"
_ "github.com/joho/godotenv/autoload"
"github.com/jybp/ebay"
"golang.org/x/oauth2"
"golang.org/x/oauth2/clientcredentials"
)
var (
integration bool
clientID string
clientSecret string
auctionURL string
)
func init() {
flag.BoolVar(&integration, "integration", false, "run integration tests")
flag.Parse()
if !integration {
return
}
clientID = os.Getenv("SANDBOX_CLIENT_ID")
clientSecret = os.Getenv("SANDBOX_CLIENT_SECRET")
if clientID == "" || clientSecret == "" {
panic("Please set SANDBOX_CLIENT_ID and SANDBOX_CLIENT_SECRET.")
}
}
func TestAuction(t *testing.T) {
if !integration {
t.SkipNow()
}
ctx := context.Background()
// You have to manually create an auction in the sandbox. Auctions can't be created using the rest api (yet?).
auctionURL = os.Getenv("SANDOX_AUCTION_URL")
conf := clientcredentials.Config{
ClientID: clientID,
ClientSecret: clientSecret,
TokenURL: "https://api.sandbox.ebay.com/identity/v1/oauth2/token",
Scopes: []string{"https://api.ebay.com/oauth/api_scope"},
}
client := ebay.NewSandboxClient(oauth2.NewClient(ctx, ebay.TokenSource(conf.TokenSource(ctx))))
lit, err := client.Buy.Browse.GetItemByLegacyID(ctx, auctionURL[strings.LastIndex(auctionURL, "/")+1:])
if err != nil {
t.Fatalf("%+v", err)
}
it, err := client.Buy.Browse.GetItem(ctx, lit.ItemID)
if err != nil {
t.Fatalf("%+v", err)
}
isAuction := false
for _, opt := range it.BuyingOptions {
if opt == ebay.BrowseBuyingOptionAuction {
isAuction = true
}
}
if !isAuction {
t.Fatalf("item %s is not an auction. BuyingOptions are: %+v", it.ItemID, it.BuyingOptions)
}
if time.Now().UTC().After(it.ItemEndDate) {
t.Fatalf("item %s end date has been reached. ItemEndDate is: %s", it.ItemID, it.ItemEndDate.String())
}
t.Logf("item %s UniqueBidderCount:%d minimumBidPrice: %+v currentPriceToBid: %+v\n", it.ItemID, it.UniqueBidderCount, it.MinimumPriceToBid, it.CurrentBidPrice)
b := make([]byte, 16)
if _, err := io.ReadFull(rand.Reader, b); err != nil {
t.Fatalf("%+v", err)
}
state := url.QueryEscape(string(b))
authCodeC := make(chan string)
mux := setupTLS()
mux.HandleFunc("/accept", func(rw http.ResponseWriter, r *http.Request) {
actualState, err := url.QueryUnescape(r.URL.Query().Get("state"))
if err != nil {
http.Error(rw, fmt.Sprintf("invalid state: %+v", err), http.StatusBadRequest)
return
}
if string(actualState) != state {
http.Error(rw, fmt.Sprintf("invalid state:\nexpected:%s\nactual:%s", state, string(actualState)), http.StatusBadRequest)
return
}
code := r.URL.Query().Get("code")
authCodeC <- code
t.Logf("The authorization code is %s.\n", code)
t.Logf("The authorization code will expire in %s seconds.\n", r.URL.Query().Get("expires_in"))
rw.Write([]byte("Accept. You can safely close this tab."))
})
mux.HandleFunc("/policy", func(rw http.ResponseWriter, r *http.Request) {
rw.Write([]byte("eBay Sniper Policy"))
})
mux.HandleFunc("/decline", func(rw http.ResponseWriter, r *http.Request) {
rw.Write([]byte("Decline. You can safely close this tab."))
})
oauthConf := oauth2.Config{
ClientID: clientID,
ClientSecret: clientSecret,
Endpoint: oauth2.Endpoint{
AuthURL: "https://auth.sandbox.ebay.com/oauth2/authorize",
TokenURL: "https://api.sandbox.ebay.com/identity/v1/oauth2/token",
},
RedirectURL: "Jean-Baptiste_P-JeanBapt-testgo-cowrprk",
Scopes: []string{"https://api.ebay.com/oauth/api_scope/buy.offer.auction"},
}
url := oauthConf.AuthCodeURL(state)
fmt.Printf("Visit the URL: %v\n", url)
authCode := <-authCodeC
tok, err := oauthConf.Exchange(ctx, authCode)
if err != nil {
t.Fatal(err)
}
client = ebay.NewSandboxClient(oauth2.NewClient(ctx, ebay.TokenSource(oauthConf.TokenSource(ctx, tok))))
bid, err := client.Buy.Offer.GetBidding(ctx, it.ItemID, ebay.BuyMarketplaceUSA)
if err != nil && !ebay.IsError(err, ebay.ErrGetBiddingNoBiddingActivity) {
t.Fatalf("Expected error code %d, got %+v.", ebay.ErrGetBiddingNoBiddingActivity, err)
}
var bidValue, bidCurrency string
if len(bid.SuggestedBidAmounts) > 0 {
bidValue = bid.SuggestedBidAmounts[0].Value
bidCurrency = bid.SuggestedBidAmounts[0].Currency
} else {
bidValue = it.CurrentBidPrice.Value
v, err := strconv.ParseFloat(bidValue, 64)
if err != nil {
t.Fatal(err)
}
v += 2
bidValue = fmt.Sprintf("%.2f", v)
bidCurrency = it.CurrentBidPrice.Currency
}
_, err = client.Buy.Offer.PlaceProxyBid(ctx, it.ItemID, ebay.BuyMarketplaceUSA, bidValue, bidCurrency, false)
if err != nil {
t.Fatal(err)
}
t.Logf("Successfully bid %+v.", bid.SuggestedBidAmounts[0])
}

View File

@@ -1,70 +0,0 @@
package integration
import (
"context"
"flag"
"os"
"strings"
"testing"
"time"
_ "github.com/joho/godotenv/autoload"
"github.com/jybp/ebay"
"github.com/jybp/ebay/clientcredentials"
)
var (
integration bool
client *ebay.Client
)
func init() {
flag.BoolVar(&integration, "integration", false, "run integration tests")
clientID := os.Getenv("SANDBOX_CLIENT_ID")
clientSecret := os.Getenv("SANDBOX_CLIENT_SECRET")
if clientID == "" || clientSecret == "" {
panic("No SANDBOX_CLIENT_ID or SANDBOX_CLIENT_SECRET. Tests won't run.")
}
conf := clientcredentials.Config{
ClientID: clientID,
ClientSecret: clientSecret,
TokenURL: "https://api.sandbox.ebay.com/identity/v1/oauth2/token",
Scopes: []string{"https://api.ebay.com/oauth/api_scope"},
}
client = ebay.NewSandboxClient(conf.Client(context.Background()))
}
func TestAuction(t *testing.T) {
if !integration {
t.SkipNow()
}
// Manually create an auction in the sandbox and copy/paste the url:
const url = "https://www.sandbox.ebay.com/itm/110439278158"
ctx := context.Background()
lit, err := client.Buy.Browse.GetItemByLegacyID(ctx, url[strings.LastIndex(url, "/")+1:])
if err != nil {
t.Fatalf("%+v", err)
}
it, err := client.Buy.Browse.GetItem(ctx, lit.ItemID)
if err != nil {
t.Fatalf("%+v", err)
}
if testing.Verbose() {
t.Logf("item: %+v", it)
}
isAuction := false
for _, opt := range it.BuyingOptions {
if opt == ebay.BrowseBuyingOptionAuction {
isAuction = true
}
}
if !isAuction {
t.Fatalf("item %s is not an auction. BuyingOptions are: %+v", it.ItemID, it.BuyingOptions)
}
if time.Now().UTC().After(it.ItemEndDate) {
t.Fatalf("item %s end date has been reached. ItemEndDate is: %s", it.ItemID, it.ItemEndDate.String())
}
t.Logf("item %s UniqueBidderCount:%d minimumBidPrice: %+v currentPriceToBid: %+v", it.ItemID, it.UniqueBidderCount, it.MinimumPriceToBid, it.CurrentBidPrice)
}

87
test/integration/tls.go Normal file
View File

@@ -0,0 +1,87 @@
package integration
// From https://gist.github.com/shivakar/cd52b5594d4912fbeb46
import (
"crypto/rand"
"crypto/rsa"
"crypto/tls"
"crypto/x509"
"crypto/x509/pkix"
"log"
"math/big"
"net"
"net/http"
"time"
)
// From https://golang.org/src/net/http/server.go
// tcpKeepAliveListener sets TCP keep-alive timeouts on accepted
// connections. It's used by ListenAndServe and ListenAndServeTLS so
// dead TCP connections (e.g. closing laptop mid-download) eventually
// go away.
type tcpKeepAliveListener struct {
*net.TCPListener
keepAlivePeriod time.Duration
}
func (ln tcpKeepAliveListener) Accept() (c net.Conn, err error) {
tc, err := ln.AcceptTCP()
if err != nil {
return
}
tc.SetKeepAlive(true)
tc.SetKeepAlivePeriod(ln.keepAlivePeriod)
return tc, nil
}
func tlsCert(name string, dur time.Duration) (tls.Certificate, error) {
now := time.Now()
template := &x509.Certificate{
SerialNumber: big.NewInt(0),
Subject: pkix.Name{CommonName: name},
NotBefore: now,
NotAfter: now.Add(dur),
BasicConstraintsValid: true,
IsCA: true,
ExtKeyUsage: []x509.ExtKeyUsage{x509.ExtKeyUsageServerAuth},
KeyUsage: x509.KeyUsageKeyEncipherment | x509.KeyUsageDigitalSignature | x509.KeyUsageCertSign,
}
priv, err := rsa.GenerateKey(rand.Reader, 2048)
if err != nil {
return tls.Certificate{}, err
}
cert, err := x509.CreateCertificate(rand.Reader, template, template, priv.Public(), priv)
if err != nil {
return tls.Certificate{}, err
}
var outCert tls.Certificate
outCert.Certificate = append(outCert.Certificate, cert)
outCert.PrivateKey = priv
return outCert, nil
}
func setupTLS() *http.ServeMux {
cert, err := tlsCert("eSniper", time.Hour)
if err != nil {
log.Fatal(err)
}
mux := http.NewServeMux()
srv := &http.Server{Addr: ":52125", Handler: mux}
cfg := &tls.Config{}
cfg.NextProtos = []string{"http/1.1"}
cfg.Certificates = make([]tls.Certificate, 1)
cfg.Certificates[0] = cert
ln, err := net.Listen("tcp", ":52125")
if err != nil {
log.Fatal(err)
}
tlsListener := tls.NewListener(tcpKeepAliveListener{ln.(*net.TCPListener), time.Minute}, cfg)
go func() {
srv.Serve(tlsListener)
}()
return mux
}