Bumped to v0.3.0 (#2)

- Add TransactionSearch API
- Move merchant to client/merchant

README.md

@@ -32,6 +32,8 @@ go-paypal-classic is library for [PayPal Classic API](https://developer.paypal.c
     - [GetRecurringPaymentsProfileDetails](https://developer.paypal.com/docs/classic/api/merchant/GetRecurringPaymentsProfileDetails_API_Operation_NVP/)
     - [ManageRecurringPaymentsProfileStatus](https://developer.paypal.com/docs/classic/api/merchant/ManageRecurringPaymentsProfileStatus_API_Operation_NVP/)
     - [SetExpressCheckout](https://developer.paypal.com/docs/classic/api/merchant/SetExpressCheckout_API_Operation_NVP/)
+- Transaction
+    - [TransactionSearch](https://developer.paypal.com/docs/classic/api/merchant/TransactionSearch_API_Operation_NVP/)
 
 ## Quick Usage
 
@@ -42,7 +44,7 @@ import (
     "os"
 
     "github.com/evalphobia/go-paypal-classic/config"
-    "github.com/evalphobia/go-paypal-classic/merchant"
+    "github.com/evalphobia/go-paypal-classic/client/merchant"
 )
 
 func main() {
@@ -75,7 +77,7 @@ func main() {
 
 ```go
 import (
-    "github.com/evalphobia/go-paypal-classic/merchant"
+    "github.com/evalphobia/go-paypal-classic/client/merchant"
 )
 
 func main() {
@@ -99,7 +101,7 @@ func main() {
 
 ```go
 import (
-    "github.com/evalphobia/go-paypal-classic/merchant"
+    "github.com/evalphobia/go-paypal-classic/client/merchant"
 )
 
 func main() {
@@ -126,7 +128,7 @@ func main() {
 
 ```go
 import (
-    "github.com/evalphobia/go-paypal-classic/merchant"
+    "github.com/evalphobia/go-paypal-classic/client/merchant"
 )
 
 func main() {
@@ -156,7 +158,7 @@ func main() {
 
 ```go
 import (
-    "github.com/evalphobia/go-paypal-classic/merchant"
+    "github.com/evalphobia/go-paypal-classic/client/merchant"
 )
 
 func main() {
@@ -179,7 +181,7 @@ func main() {
 
 ```go
 import (
-    "github.com/evalphobia/go-paypal-classic/merchant"
+    "github.com/evalphobia/go-paypal-classic/client/merchant"
 )
 
 func main() {
@@ -199,3 +201,29 @@ func main() {
     }
 }
 ```
+
+### TransactionSearch
+
+```go
+import (
+    "time"
+
+    "github.com/evalphobia/go-paypal-classic/client/transaction"
+)
+
+func main() {
+    ts = &transaction.TransactionSearch{
+        StartDate: time.Now(),
+        ProfileID: "I-000000000000",
+    }
+    resp, err := ts.Do(cli)
+    if err != nil {
+        panic("error occured on TransactionSearch api request")
+    }
+
+    if resp.IsSuccess() {
+        // transaction list
+        // resp.Items
+    }
+}
+```

merchant/base.go → client/base.go

@@ -1,9 +1,15 @@
-package merchant
+package client
 
 import (
 	"strings"
 )
 
+// ACK statuses.
+const (
+	ACKSuccess = "Success"
+	ACKFailure = "Failure"
+)
+
 // BaseRequest is base struct for api request
 type BaseRequest struct {
 	Method string `url:"METHOD"`
@@ -31,6 +37,11 @@ type BaseResponse struct {
 	SeverityCode1 string `url:"L_SEVERITYCODE1"`
 }
 
+// IsRequestSuccess checks the request is success or not.
+func (r BaseResponse) IsRequestSuccess() bool {
+	return r.ACK == ACKSuccess
+}
+
 func (r BaseResponse) baseError() []string {
 	var errs []string
 	if r.ShortMessage != "" {
@@ -58,8 +69,8 @@ func parseErrors(errs []string) string {
 	return strings.Join(errs, ",")
 }
 
-// MerchantResponse is interface of response from each API
-type MerchantResponse interface {
+// Response is interface of response from each API
+type Response interface {
 	IsSuccess() bool
 	IsRequestSuccess() bool
 	IsOperationSuccess() bool

client/client.go

@@ -0,0 +1,56 @@
+package client
+
+import (
+	"github.com/evalphobia/go-paypal-classic/config"
+	"github.com/evalphobia/go-paypal-classic/request"
+)
+
+const (
+	endpointSandbox    = "https://api-3t.sandbox.paypal.com/nvp"
+	endpointProduction = "https://api-3t.paypal.com/nvp"
+
+	redirectSandbox    = "https://www.sandbox.paypal.com/webscr"
+	redirectProduction = "https://www.paypal.com/webscr"
+)
+
+// Client is base struct for PayPal Classic API
+type Client struct {
+	Config *config.Config `url:",squash"`
+}
+
+// New creates Client with given config
+func New(conf *config.Config) Client {
+	return Client{
+		Config: conf,
+	}
+}
+
+// NewDefault creates Client with default config
+func NewDefault() Client {
+	return New(config.DefaultConfig)
+}
+
+// Call sends HTTP request to PayPal api.
+func (c Client) Call(param interface{}, result interface{}) error {
+	p := parameter{
+		Common: c,
+		Extra:  param,
+	}
+	if c.Config.IsProduction() {
+		return request.CallPOST(endpointProduction, p, result)
+	}
+	return request.CallPOST(endpointSandbox, p, result)
+}
+
+type parameter struct {
+	Common Client      `url:",squash"`
+	Extra  interface{} `url:",squash"`
+}
+
+// RedirectBase returns base url of PayPal ExpressCheckout
+func (c Client) RedirectBase() string {
+	if c.Config.IsProduction() {
+		return redirectProduction
+	}
+	return redirectSandbox
+}

merchant/client_test.go → client/client_test.go

@@ -1,4 +1,4 @@
-package merchant
+package client
 
 import (
 	"testing"

client/merchant/client.go

@@ -0,0 +1,13 @@
+package merchant
+
+import (
+	"github.com/evalphobia/go-paypal-classic/client"
+	"github.com/evalphobia/go-paypal-classic/config"
+)
+
+// New creates client.Client with given config
+func New(conf *config.Config) client.Client {
+	return client.Client{
+		Config: conf,
+	}
+}

merchant/currency.go → client/merchant/const.go

@@ -1,5 +1,20 @@
 package merchant
 
+import "github.com/evalphobia/go-paypal-classic/client"
+
+const (
+	paymentActionSale    = "sale"
+	payerStatusVerified  = "verified"
+	itemCategoryDigital  = "Digital"
+	billingTypeRecurring = "RecurringPayments"
+
+	statusActive          = "Active"
+	profileActive         = "ActiveProfile"
+	paymentStatusComleted = "Completed"
+
+	ackSuccess = client.ACKSuccess
+)
+
 // PayPal supported currencies
 const (
 	CurrencyAUD = "AUD"

merchant/create_recurring_payments_profile.go → client/merchant/create_recurring_payments_profile.go

@@ -2,13 +2,14 @@ package merchant
 
 import (
 	"time"
+
+	"github.com/evalphobia/go-paypal-classic/client"
 )
 
 // CreateRecurringPaymentsProfile is struct for CreateRecurringPaymentsProfile API
 // see: https://developer.paypal.com/docs/classic/api/merchant/CreateRecurringPaymentsProfile_API_Operation_NVP/
 type CreateRecurringPaymentsProfile struct {
-	Merchant    `url:",squash"`
-	BaseRequest `url:",squash"`
+	client.BaseRequest `url:",squash"`
 
 	BillingPeriod    string `url:"BILLINGPERIOD"`
 	BillingFrequency int    `url:"BILLINGFREQUENCY"`
@@ -64,25 +65,20 @@ func (svc *CreateRecurringPaymentsProfile) SetBillingStartDateFromNow() {
 	}
 }
 
-// SetMerchant sets Merchant
-func (svc *CreateRecurringPaymentsProfile) SetMerchant(m Merchant) {
-	svc.Merchant = m
-}
-
 // Do executes CreateRecurringPaymentsProfile operation
-func (svc *CreateRecurringPaymentsProfile) Do(m Merchant) (*CreateRecurringPaymentsProfileResponse, error) {
+func (svc *CreateRecurringPaymentsProfile) Do(cli client.Client) (*CreateRecurringPaymentsProfileResponse, error) {
 	const method = "CreateRecurringPaymentsProfile"
 	svc.BaseRequest.Method = method
 	svc.BaseRequest.Action = paymentActionSale
 
 	result := &CreateRecurringPaymentsProfileResponse{}
-	err := m.call(svc, result)
+	err := cli.Call(svc, result)
 	return result, err
 }
 
 // CreateRecurringPaymentsProfileResponse is struct for response of CreateRecurringPaymentsProfile API
 type CreateRecurringPaymentsProfileResponse struct {
-	BaseResponse `url:",squash"`
+	client.BaseResponse `url:",squash"`
 
 	// success
 	Token         string `url:"TOKEN"`
@@ -95,11 +91,6 @@ func (r *CreateRecurringPaymentsProfileResponse) IsSuccess() bool {
 	return r.IsRequestSuccess() && r.IsOperationSuccess()
 }
 
-// IsRequestSuccess checks the request is success or not
-func (r *CreateRecurringPaymentsProfileResponse) IsRequestSuccess() bool {
-	return r.ACK == ackSuccess
-}
-
 // IsOperationSuccess checks the request is success or not
 func (r *CreateRecurringPaymentsProfileResponse) IsOperationSuccess() bool {
 	return r.ProfileStatus == profileActive

merchant/create_recurring_payments_profile_test.go → client/merchant/create_recurring_payments_profile_test.go

@@ -4,12 +4,18 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/assert"
+
+	"github.com/evalphobia/go-paypal-classic/client"
 )
 
+func testNewDefault() client.Client {
+	return client.NewDefault()
+}
+
 func TestCreateRecurringPaymentsProfile(t *testing.T) {
 	assert := assert.New(t)
 
-	m := NewDefault()
+	cli := testNewDefault()
 
 	// error
 	svc := &CreateRecurringPaymentsProfile{
@@ -21,7 +27,7 @@ func TestCreateRecurringPaymentsProfile(t *testing.T) {
 	}
 	svc.SetPeriodAsMonth(13)
 	svc.SetBillingStartDateFromNow()
-	v, err := svc.Do(m)
+	v, err := svc.Do(cli)
 	assert.Nil(err)
 	assert.Equal("Failure", v.ACK)
 	assert.Equal("124", v.Version)

merchant/do_express_checkout_payment.go → client/merchant/do_express_checkout_payment.go

@@ -1,10 +1,11 @@
 package merchant
 
+import "github.com/evalphobia/go-paypal-classic/client"
+
 // DoExpressCheckoutPayment is struct for DoExpressCheckoutPayment API
 // see: https://developer.paypal.com/docs/classic/api/merchant/DoExpressCheckoutPayment_API_Operation_NVP/
 type DoExpressCheckoutPayment struct {
-	Merchant    `url:",squash"`
-	BaseRequest `url:",squash"`
+	client.BaseRequest `url:",squash"`
 
 	Token   string `url:"TOKEN"`
 	PayerID string `url:"PAYERID"`
@@ -15,13 +16,8 @@ type DoExpressCheckoutPayment struct {
 	Currency    string  `url:"PAYMENTREQUEST_0_CURRENCYCODE"`
 }
 
-// SetMerchant sets Merchant
-func (svc *DoExpressCheckoutPayment) SetMerchant(m Merchant) {
-	svc.Merchant = m
-}
-
 // Do executes DoExpressCheckoutPayment operation
-func (svc *DoExpressCheckoutPayment) Do(m Merchant) (*DoExpressCheckoutPaymentResponse, error) {
+func (svc *DoExpressCheckoutPayment) Do(cli client.Client) (*DoExpressCheckoutPaymentResponse, error) {
 	const method = "DoExpressCheckoutPayment"
 	svc.BaseRequest.Method = method
 	svc.BaseRequest.Action = paymentActionSale
@@ -31,13 +27,13 @@ func (svc *DoExpressCheckoutPayment) Do(m Merchant) (*DoExpressCheckoutPaymentRe
 	}
 
 	result := &DoExpressCheckoutPaymentResponse{}
-	err := m.call(svc, result)
+	err := cli.Call(svc, result)
 	return result, err
 }
 
 // DoExpressCheckoutPaymentResponse is struct for response of DoExpressCheckoutPayment API
 type DoExpressCheckoutPaymentResponse struct {
-	BaseResponse `url:",squash"`
+	client.BaseResponse `url:",squash"`
 
 	// success
 	Token string `url:"TOKEN"`
@@ -75,11 +71,6 @@ func (r *DoExpressCheckoutPaymentResponse) IsSuccess() bool {
 	return r.IsRequestSuccess() && r.IsOperationSuccess()
 }
 
-// IsRequestSuccess checks the request is success or not
-func (r *DoExpressCheckoutPaymentResponse) IsRequestSuccess() bool {
-	return r.ACK == ackSuccess
-}
-
 // IsOperationSuccess checks the request is success or not
 func (r *DoExpressCheckoutPaymentResponse) IsOperationSuccess() bool {
 	return r.PaymentACK == ackSuccess

merchant/do_express_checkout_payment_test.go → client/merchant/do_express_checkout_payment_test.go

@@ -9,7 +9,7 @@ import (
 func TestDoExpressCheckoutPayment(t *testing.T) {
 	assert := assert.New(t)
 
-	m := NewDefault()
+	cli := testNewDefault()
 
 	// error
 	svc := &DoExpressCheckoutPayment{
@@ -18,7 +18,7 @@ func TestDoExpressCheckoutPayment(t *testing.T) {
 		TotalAmount: 200.0,
 		Currency:    CurrencyTWD,
 	}
-	v, err := svc.Do(m)
+	v, err := svc.Do(cli)
 	assert.Nil(err)
 	assert.Equal("Failure", v.ACK)
 	assert.Equal("124", v.Version)