omise-go v2 (codegen) #42

rezigned · 2020-05-28T10:02:02Z

Code generation

Testing

Fix tests
Add missing tests (for new endpoints)
Test real network requests

New API Design

Upgrade to new design
Add context support

New API Design

charge, err := client.Charge().Create(ctx, &omise.CreateChargeParams{
	Amount:      204842,
	Currency:    "THB",
	Description: "initial charge.",
	Card:        token.ID,
})

Others

Update README.md
Remove forum link

iporsut · 2020-06-25T04:15:17Z

Could you add newline at the end of file of generated file?

rezigned · 2020-06-25T04:55:43Z

Sure krub. Thank you.

Add type alias and rename based struct for List Regenerate *_list.go Generate resource files (wip) Remove Base struct + regenerate request files Prepend omise package prefix to field type + auto import package Generate nested resources (wip) Add resource prefix for list actions Fix duplicate refund struct types Append List struct to list operations Update ordering path to v2 Generate extra params for endpoints Regenerate operations/* Generate all params Generate Vault endpoint for token Update test to include v2 Update fixtures path Generate comments Ignore golint for now (focus on tests) Generate omitempty tags Generate struct pointers Reorder json fields in tests Regenerate int64 and int types Update fixtures path Force non-null fields Generate *bool for charge.capture Generate documentation (wip) Generate documentation (wip) Add tests for capability Generate float64 for floating point fields Add tests for forex Add DateString type for date fields in params Generate custom DateString type Fix test failed due to case-sensitivity in linux Update tests for schedule + make Weekday non-pointer Fix more tests in schedule resource Make Schedule's start_date and end_date nullable Generate ListChargeSchedules struct Re-generate ListChargeSchedules struct Make enum types non-reference Update tests and fixtures for source Add tests for system_info (/) Generate search types Re-generate event.data Update tests for schedule Add network tests for source Re-enable golint for v2 Add comments for enums Generate comments for enums Generate more comments Remove old codes Regenerate files with newlines at the end of files Regenerate files with newlines at the end of files (cont) Regenerate files with newlines at the end of files (cont) Regenerate files with newlines at the end of files (done) Cleanup go mod dependencies

Update new API design Update method description Update method description (cont) Update method description (cont) Update method description (cont) Update method description (cont) Update Account tests Update Balance tests Update Capability tests Update Card tests Update Charge tests Update Charge tests (github's down) Update Charge tests Add default API Version Update Charge tests Update Customer tests Fix wrong version in client_test Regenerate list resources Regenerate dispute resource Update Event/Forex/Link tests Update List tests Update Occurrence tests Update Recipient tests + Regenerate params Update Refund tests Update Source tests Update SystemInfo tests Update Transaction tests Update Transfer tests Update Token tests Update Schedule tests Update Search tests Update Search tests Regenerate Search resource Regenerate ChargeStatus Add context support Use req.Context instead of NewRequestWithContext due to go versions (1.13+) Refactor Client.Do

choestelus · 2020-08-26T04:26:30Z

I think this need to run gofmt first, even if it is generated code. what do you think? @rezigned

choestelus · 2020-08-26T04:31:54Z

v2/date.go

+
+// UnmarshalJSON Date type
+func (d *Date) UnmarshalJSON(b []byte) error {
+	tm, err := time.Parse("\"2006-01-02\"", string(b))


this could be

tm, err := time.Parse(`"2006-01-02"`, string(b))

instead of escaping special characters

choestelus · 2020-08-26T04:39:44Z

v2/internal/endpoint.go

+
+const (
+	API   Endpoint = "https://api.omise.co"
+	Vault          = "https://vault.omise.co"


is untyped constant here intended?

choestelus · 2020-08-26T04:41:40Z

v2/internal/testutil/fixtures_transport.go

+	"net/http"
+)
+
+var _ = fmt.Println


is there any reason for fmt to remains as imported package here?

choestelus · 2020-08-26T04:49:14Z

v2/internal/testutil/testutil.go

+	return ok
+}
+
+func assertJSONEquals(t *testing.T, prefix string, m1 map[string]interface{}, m2 map[string]interface{}) {


there's https://pkg.go.dev/github.com/stretchr/testify/require?tab=doc#JSONEq for this kind of assertion and it's already imported here. could be use that instead

choestelus · 2020-08-26T04:51:26Z

v2/mfa_recovery_codes.go

+package omise
+
+// MfaRecoveryCodes represents resource object.
+type MfaRecoveryCodes struct {


acronym in go should remains all capital case, Mfa -> MFA if this is Multi-Factor Authentication here

choestelus · 2020-08-26T04:55:29Z

v2/operations/customer_test.go

+	r "github.com/stretchr/testify/require"
+)
+
+var _ = fmt.Println


remove this

choestelus · 2020-08-26T05:00:44Z

v2/operations/receipt_test.go

+
+	client := testutil.NewFixedClient(t)
+	receipt, _ := client.Receipt().Retrieve(context.Background(), &omise.RetrieveReceiptParams{ReceiptID})
+	a.Equal(t, ReceiptID, receipt.ID)


should check first if receipt is not nil if using assert package, not require here
otherwise when this fails, everything else will be failed too and produce a lot of useless failure messages since the root cause is nil.

choestelus · 2020-08-26T05:09:23Z

v2/operations/transfer_test.go

+	expected := `{"amount":192188}`
+
+	b, err := json.Marshal(req)
+	r.Nil(t, err, "err should be nothing")


use r.NoError(t, err, "err should be nothing") here

choestelus · 2020-08-26T05:11:15Z

v2/qr_code.go

+type QrCode struct {
+	Base
+	Email string `json:"email"`
+	MfaProvisioningURI string `json:"mfa_provisioning_uri"`


Mfa here should be MFA or there's some limitations that prevent this kind of naming?

choestelus · 2020-08-26T05:17:57Z

v2/source_type.go

+	SourceInstallmentKtc SourceType = "installment_ktc"
+	SourceInternetBankingBay SourceType = "internet_banking_bay"
+	SourceInternetBankingBbl SourceType = "internet_banking_bbl"
+	SourceInternetBankingKtb SourceType = "internet_banking_ktb"
+	SourceInternetBankingScb SourceType = "internet_banking_scb"


isn't it should be all-capital letters for bank acronym, not camelCase?

choestelus · 2020-08-26T05:18:33Z

v2/testdata/fixtures/api.omise.co/-get.json

+  "versions": [
+     "2019-05-29"
+  ]
+}


newline here please

choestelus · 2020-08-26T05:19:01Z

v2/testdata/fixtures/api.omise.co/capability-get.json

+  ],
+  "country": "TH",
+  "zero_interest_installments": true
+}


newline here please

choestelus · 2020-08-26T05:21:46Z

v2/testdata/fixtures/api.omise.co/forex/usd-get.json

+  "base": "USD",
+  "quote": "THB",
+  "rate": 30.4847017
+}


newline here please

choestelus · 2020-08-26T05:22:02Z

v2/testdata/fixtures/api.omise.co/occurrences/occu_57z9hj228pusa652nk1-get.json

+  "message": null,
+  "result": null,
+  "created": "2017-06-08T04:46:50Z"
+}


newline please

choestelus · 2020-08-26T05:23:55Z

v2/testdata/fixtures/api.omise.co/schedules/schd_57z9hj228pusa652nk1/occurrences-get.json

+        "created": "2017-06-08T04:46:50Z"
+      }
+    ]
+}


newline please

choestelus · 2020-08-26T05:25:15Z

v2/testdata/fixtures/api.omise.co/sources-post.json

+  "terminal_id": "POS-01",
+  "type": "bill_payment_tesco_lotus",
+  "zero_interest_installments": null
+}


newline please

choestelus · 2020-08-26T05:25:34Z

v2/testdata/fixtures/api.omise.co/sources/src_test_5a444nhh27tlyv81u40-get.json

+  "terminal_id": "POS-01",
+  "type": "bill_payment_tesco_lotus",
+  "zero_interest_installments": null
+}


newline here too please

choestelus · 2020-08-26T05:26:42Z

v2/testdata/fixtures/api.omise.co/transfers-get.json

+        "name": "JOHN DOE",
+        "created": "2015-06-02T09:26:59Z"
+      },
+      "created": "2015-01-15T10:04:47Z"


is missing comma at the end of this line intended?

sonarqubecloud · 2022-08-03T05:47:06Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
29 Code Smells

No Coverage information
0.0% Duplication

Add go.mod for v2 and generate model files

b01d1bc

rezigned force-pushed the omise-go-v2 branch 2 times, most recently from 25c36e1 to 76a4402 Compare June 15, 2020 09:52

rezigned changed the title ~~Add go.mod for omise-go v2 and generate model files~~ omise-go v2 (codegen) Jun 23, 2020

rezigned force-pushed the omise-go-v2 branch 2 times, most recently from 5aafb1f to 80be80a Compare July 1, 2020 04:48

rezigned added 2 commits July 1, 2020 13:23

rezigned force-pushed the omise-go-v2 branch from 9719da5 to 05b7621 Compare July 1, 2020 06:24

Update code examples

865f518