Skip to content

Commit d86e479

Browse files
author
Alireza Josheghani
committed
Update package url, adding go mod file
Adding github action for tests
1 parent 25d4d18 commit d86e479

File tree

9 files changed

+239
-239
lines changed

9 files changed

+239
-239
lines changed

‎.circleci/config.yml

Lines changed: 0 additions & 18 deletions
This file was deleted.

‎.github/workflows/go-tests.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Run tests on all branches
2+
3+
on:
4+
push:
5+
branches:
6+
- "*"
7+
tags:
8+
- "*"
9+
10+
jobs:
11+
build:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: actions/checkout@v2
15+
16+
- name: Set up Go
17+
uses: actions/setup-go@v2
18+
with:
19+
go-version: 1.16
20+
21+
- name: Run tests
22+
run: go test -v -race

‎README.md

Lines changed: 20 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,110 +1,92 @@
1-
[![Build Status](https://circleci.com/gh/iamalirezaj/go-respond.svg?&style=shield)](https://circleci.com/gh/iamalirezaj/go-respond)
2-
[![Go Report](https://goreportcard.com/badge/github.com/iamalirezaj/go-respond)](https://goreportcard.com/report/github.com/iamalirezaj/go-respond)
3-
[![License](https://img.shields.io/:license-mit-blue.svg?style=flat-square)](#license)
4-
51
# Go Respond
6-
72
This package is provided to be used on golang and it gives clean methods to handle json response with specific predetermined messages.
83

9-
# Requirement
10-
* Golang 1.10
11-
* gopkg.in/yaml.v2
12-
13-
**The package is in process.**
14-
154
## Install
16-
17-
Run this commands
18-
19-
$ go get gopkg.in/yaml.v2
20-
21-
$ go get github.com/iamalirezaj/go-respond
5+
$ go get github.com/mrjosh/respond.go
226

237
## Usage
24-
25-
You can use these methods in deffernt ways:
26-
27-
There are hot ones for quick usage, besides some provided to manage outputs on your own way
28-
298
import package
309
```go
31-
import "github.com/iamalirezaj/go-respond"
10+
import "github.com/mrjosh/respond.go"
3211
```
3312

3413
create respond instance
3514
```go
36-
var respond josh.Respond
15+
var jspon = respond.Default
16+
17+
// or if you want to use custom languages
18+
var jspon = respond.DefaultWithLang("fa")
3719
```
3820

3921
**Some are shown below:**
4022

4123
When request succeeds and contains data to return as a result:
4224
```go
43-
respond.Succeed(map[string] interface{} {
25+
jspon.Succeed(map[string] interface{} {
4426
"some_key": "some_data"
4527
})
4628
```
4729

4830
When deletion action succeeds:
4931
```go
50-
respond.DeleteSucceeded()
32+
jspon.DeleteSucceeded()
5133
```
5234

5335
When updating succeeds:
5436
```go
55-
respond.UpdateSucceeded()
37+
jspon.UpdateSucceeded()
5638
```
5739

5840
When insertion succeeds:
5941
```go
60-
respond.InsertSucceeded()
42+
jspon.InsertSucceeded()
6143
```
6244

6345
When deletion action fails:
6446
```go
65-
respond.DeleteFaild()
47+
jspon.DeleteFaild()
6648
```
6749

6850
When updating fails:
6951
```go
70-
respond.UpdateFaild()
52+
jspon.UpdateFaild()
7153
```
7254

7355
when insertion fails:
7456
```go
75-
respond.InsertFaild()
57+
jspon.InsertFaild()
7658
```
7759

7860
Not Found Error:
7961
```go
80-
respond.NotFound()
62+
jspon.NotFound()
8163
```
8264

8365
When parameters entered are wrong:
8466
```go
85-
respond.WrongParameters()
67+
jspon.WrongParameters()
8668
```
8769

8870
When requested method is not allowed:
8971
```go
90-
respond.MethodNotAllowed()
72+
jspon.MethodNotAllowed()
9173
```
9274

9375
```go
94-
respond.RequestFieldNotFound()
76+
jspon.RequestFieldNotFound()
9577
```
9678

9779
Validation errors:
9880
```go
99-
respond.ValidationErrors(map[string] interface{} {
100-
"some_key": "some_validation_errors_data"
81+
jspon.ValidationErrors(map[string] interface{} {
82+
"some_key": "some_validation_errors_data"
10183
})
10284
```
10385

10486
###customization
10587
You can do more:
10688
```go
107-
respond.SetStatusCode(200).setStatusText('Success.').RespondWithMessage('Your custom message')
89+
jspon.SetStatusCode(200).setStatusText('Success.').RespondWithMessage('Your custom message')
10890
```
10991

11092
## License

‎go.mod

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
module github.com/mrjosh/respond.go
2+
3+
go 1.16
4+
5+
require github.com/stretchr/testify v1.7.0 // indirect

‎go.sum

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
2+
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
3+
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
4+
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
5+
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
6+
github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
7+
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
8+
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
9+
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
10+
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

‎message.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
package respond
22

33
import (
4-
"github.com/MrJoshLab/go-respond/translations/en"
5-
"github.com/MrJoshLab/go-respond/translations/fa"
4+
"github.com/mrjosh/respond.go/translations/en"
5+
"github.com/mrjosh/respond.go/translations/fa"
66
)
77

88
type Message struct {
@@ -17,7 +17,7 @@ type Message struct {
1717
Failed string
1818

1919
// respond error messages
20-
Errors map[string] map[string] interface{}
20+
Errors map[string]map[string]interface{}
2121
}
2222

2323
// Load config of response language
@@ -27,7 +27,7 @@ type Message struct {
2727
// @return *Message
2828
func (message *Message) LoadConfig() *Message {
2929

30-
var translation map[string] interface{}
30+
var translation map[string]interface{}
3131

3232
switch message.Lang {
3333
case "fa":
@@ -36,7 +36,7 @@ func (message *Message) LoadConfig() *Message {
3636
translation = en.Errors
3737
}
3838

39-
message.Errors = translation["errors"].(map[string] map[string] interface{})
39+
message.Errors = translation["errors"].(map[string]map[string]interface{})
4040
message.Success = translation["success"].(string)
4141
message.Failed = translation["failed"].(string)
4242

‎respond_test.go

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ package respond
22

33
import (
44
"testing"
5+
56
"github.com/stretchr/testify/assert"
67
)
78

@@ -10,7 +11,7 @@ func TestNotFound(test *testing.T) {
1011
statusCode, result := Default.NotFound()
1112

1213
assert.Equal(test, 404, statusCode)
13-
assert.Equal(test, map[string] interface{} {
14+
assert.Equal(test, map[string]interface{}{
1415
"message": "Oops... The requested page not found!",
1516
"status": "failed",
1617
"error": 5404,
@@ -19,14 +20,14 @@ func TestNotFound(test *testing.T) {
1920

2021
func TestSucceed(test *testing.T) {
2122

22-
statusCode, result := Default.Succeed(map[string] interface{} {
23+
statusCode, result := Default.Succeed(map[string]interface{}{
2324
"data": "Test",
2425
})
2526

2627
assert.Equal(test, 200, statusCode)
27-
assert.Equal(test, map[string] interface{} {
28+
assert.Equal(test, map[string]interface{}{
2829
"status": "success",
29-
"result": map[string] interface{} {
30+
"result": map[string]interface{}{
3031
"data": "Test",
3132
},
3233
}, result)
@@ -37,7 +38,7 @@ func TestInsertSucceeded(test *testing.T) {
3738
statusCode, result := Default.InsertSucceeded()
3839

3940
assert.Equal(test, 200, statusCode)
40-
assert.Equal(test, map[string] interface{} {
41+
assert.Equal(test, map[string]interface{}{
4142
"message": "The requested parameter is added successfully!",
4243
"status": "success",
4344
}, result)
@@ -48,7 +49,7 @@ func TestInsertFailed(test *testing.T) {
4849
statusCode, result := Default.InsertFailed()
4950

5051
assert.Equal(test, 448, statusCode)
51-
assert.Equal(test, map[string] interface{} {
52+
assert.Equal(test, map[string]interface{}{
5253
"message": "The requested parameter is not added!",
5354
"status": "failed",
5455
}, result)
@@ -59,7 +60,7 @@ func TestDeleteSucceeded(test *testing.T) {
5960
statusCode, result := Default.DeleteSucceeded()
6061

6162
assert.Equal(test, 200, statusCode)
62-
assert.Equal(test, map[string] interface{} {
63+
assert.Equal(test, map[string]interface{}{
6364
"message": "The requested parameter is deleted successfully!",
6465
"status": "success",
6566
}, result)
@@ -70,7 +71,7 @@ func TestDeleteFailed(test *testing.T) {
7071
statusCode, result := Default.DeleteFailed()
7172

7273
assert.Equal(test, 447, statusCode)
73-
assert.Equal(test, map[string] interface{} {
74+
assert.Equal(test, map[string]interface{}{
7475
"message": "The requested parameter is not deleted!",
7576
"status": "failed",
7677
}, result)
@@ -81,7 +82,7 @@ func TestUpdateSucceeded(test *testing.T) {
8182
statusCode, result := Default.UpdateSucceeded()
8283

8384
assert.Equal(test, 200, statusCode)
84-
assert.Equal(test, map[string] interface{} {
85+
assert.Equal(test, map[string]interface{}{
8586
"message": "The requested parameter is updated successfully!",
8687
"status": "success",
8788
}, result)
@@ -92,7 +93,7 @@ func TestUpdateFailed(test *testing.T) {
9293
statusCode, result := Default.UpdateFailed()
9394

9495
assert.Equal(test, 449, statusCode)
95-
assert.Equal(test, map[string] interface{} {
96+
assert.Equal(test, map[string]interface{}{
9697
"message": "The requested parameter is not updated!",
9798
"status": "failed",
9899
}, result)
@@ -103,7 +104,7 @@ func TestWrongParameters(test *testing.T) {
103104
statusCode, result := Default.WrongParameters()
104105

105106
assert.Equal(test, 406, statusCode)
106-
assert.Equal(test, map[string] interface{} {
107+
assert.Equal(test, map[string]interface{}{
107108
"message": "Oops... The parameters you entered are wrong!",
108109
"status": "failed",
109110
"error": 5406,
@@ -115,7 +116,7 @@ func TestMethodNotAllowed(test *testing.T) {
115116
statusCode, result := Default.MethodNotAllowed()
116117

117118
assert.Equal(test, 405, statusCode)
118-
assert.Equal(test, map[string] interface{} {
119+
assert.Equal(test, map[string]interface{}{
119120
"message": "Oops... The method you requested is not allowed!",
120121
"status": "failed",
121122
"error": 5405,
@@ -124,14 +125,14 @@ func TestMethodNotAllowed(test *testing.T) {
124125

125126
func TestValidationErrors(test *testing.T) {
126127

127-
statusCode, result := Default.ValidationErrors(map[string] interface{} {
128+
statusCode, result := Default.ValidationErrors(map[string]interface{}{
128129
"data": "Test",
129130
})
130131

131132
assert.Equal(test, 420, statusCode)
132-
assert.Equal(test, map[string] interface{} {
133+
assert.Equal(test, map[string]interface{}{
133134
"status": "failed",
134-
"result": map[string] interface{} {
135+
"result": map[string]interface{}{
135136
"data": "Test",
136137
},
137138
}, result)
@@ -142,7 +143,7 @@ func TestRequestFieldNotfound(test *testing.T) {
142143
statusCode, result := Default.RequestFieldNotfound()
143144

144145
assert.Equal(test, 446, statusCode)
145-
assert.Equal(test, map[string] interface{} {
146+
assert.Equal(test, map[string]interface{}{
146147
"status": "failed",
147148
"error": 1001,
148149
"message": "Oops... Requested field is not found!",
@@ -154,7 +155,7 @@ func TestRequestFieldDuplicated(test *testing.T) {
154155
statusCode, result := Default.RequestFieldDuplicated()
155156

156157
assert.Equal(test, 400, statusCode)
157-
assert.Equal(test, map[string] interface{} {
158+
assert.Equal(test, map[string]interface{}{
158159
"status": "failed",
159160
"error": 1004,
160161
"message": "Failed because of duplicate",
@@ -166,7 +167,7 @@ func TestDefaultWithLang(test *testing.T) {
166167
statusCode, result := DefaultWithLang("fa").NotFound()
167168

168169
assert.Equal(test, 404, statusCode)
169-
assert.Equal(test, map[string] interface{} {
170+
assert.Equal(test, map[string]interface{}{
170171
"status": "نا موفق",
171172
"error": 5404,
172173
"message": ".صفحه درخواست شده پیدا نمیشود",

0 commit comments

Comments
 (0)