Skip to content

Commit fb9db3d

Browse files
GopherSuslikGopherSuslik
committed
inited a go-pocket-sdk
0 parents  commit fb9db3d

File tree

12 files changed

+1197
-0
lines changed

12 files changed

+1197
-0
lines changed

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.idea

‎Makefile‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.PHONY: test
2+
test:
3+
go test -v -race -cover ./...

‎README.md‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# GetPocket API Golang SDK
2+
3+
[![Release](https://img.shields.io/badge/release-v1.0.0-blue)](https://github.com/Lapp-coder/go-pocket-sdk/releases)
4+
5+
### The basis of the package was made on code from [this](https://github.com/zhashkevych/go-pocket-sdk) repository.
6+
7+
### [Русская версия README файла](README_RU.md)
8+
9+
***
10+
11+
## Introduction:
12+
#### To create a new client, you need to get the consumer key that you get when you create your application on the getpocket website, specifically [here](https://getpocket.com/developer/apps/new)
13+
#### When you create this application, you can specify the permissions to use of certain APIs.
14+
#### It is important to note that if you do not specify any of these permissions, you will get an error when trying to call it (the API method) from the code, even if everything else goes well.
15+
16+
17+
## Example usage:
18+
```go
19+
package main
20+
21+
import (
22+
"context"
23+
"fmt"
24+
pocket "github.com/Lapp-coder/go-pocket-sdk"
25+
"log"
26+
"time"
27+
)
28+
29+
func main() {
30+
ctx := context.Background()
31+
32+
client, err := pocket.NewClient("<your-consumer-key>")
33+
if err != nil {
34+
log.Fatal(err)
35+
}
36+
37+
requestToken, err := client.GetRequestToken(ctx, "https://google.com", "")
38+
if err != nil {
39+
log.Fatal(err)
40+
}
41+
42+
authURL, _ := client.GetAuthorizationURL(requestToken, "https://google.com")
43+
fmt.Println(authURL)
44+
45+
// I wait for the user to click on the authorization link and grant rights to the application,
46+
// Then I continue executing the program.
47+
fmt.Scanln()
48+
49+
auth, err := client.Authorize(ctx, requestToken)
50+
if err != nil {
51+
log.Fatal(err)
52+
}
53+
54+
// Adding a new element
55+
_ = client.Add(ctx, pocket.AddInput{
56+
AccessToken: auth.AccessToken,
57+
URL: "https://github.com",
58+
})
59+
60+
// Getting all user items
61+
items, _ := client.Retrieving(ctx, pocket.RetrievingInput{
62+
AccessToken: auth.AccessToken,
63+
Favorite: "0",
64+
})
65+
66+
for _, v := range items {
67+
// Modifying all found user elements
68+
actions := []pocket.Action{
69+
{Name: pocket.Favorite, ItemId: v.ItemId, Time: time.Now().Unix()},
70+
{Name: pocket.Archive, ItemId: v.ItemId, Time: time.Now().Unix()},
71+
{Name: pocket.TagsAdd, ItemId: v.ItemId, Tags: "github.com, github, system-version-control"},
72+
}
73+
74+
_ = client.Modify(ctx, pocket.ModifyInput{
75+
AccessToken: auth.AccessToken,
76+
Actions: actions,
77+
})
78+
}
79+
}
80+
```

‎README_RU.md‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# GetPocket API Golang SDK
2+
3+
[![Release](https://img.shields.io/badge/release-v1.0.0-blue)](https://github.com/Lapp-coder/go-pocket-sdk/releases)
4+
5+
### Основа пакета была сделана на коде из [этого](https://github.com/zhashkevych/go-pocket-sdk) репозитория.
6+
7+
### [English version of the README file](README.md)
8+
9+
***
10+
11+
## Введение:
12+
#### Для создания нового клиента вам потребуется получить consumer key, который выдается при создании вашего приложения на сайте getpocket, а конкретнее [здесь](https://getpocket.com/developer/apps/new).
13+
#### При создании этого приложения вы можете указать разрешения на использование тех или иных API.
14+
#### Важно отметить, что если вы не укажите какое-либо из этих разрешений, вы будете получать ошибку, пытаясь вызвать его (API метод) из кода, даже если все остальное пройдет успешно.
15+
16+
## Пример использования:
17+
```go
18+
package main
19+
20+
import (
21+
"context"
22+
"fmt"
23+
pocket "github.com/Lapp-coder/go-pocket-sdk"
24+
"log"
25+
"time"
26+
)
27+
28+
func main() {
29+
ctx := context.Background()
30+
31+
client, err := pocket.NewClient("<ваш-consumer-key>")
32+
if err != nil {
33+
log.Fatal(err)
34+
}
35+
36+
requestToken, err := client.GetRequestToken(ctx, "https://google.com", "")
37+
if err != nil {
38+
log.Fatal(err)
39+
}
40+
41+
authURL, _ := client.GetAuthorizationURL(requestToken, "https://google.com")
42+
fmt.Println(authURL)
43+
44+
// Жду, пока пользователь нажмет на ссылку авторизации и предоставит права приложению.
45+
// Затем продолжаю выполнение программы
46+
fmt.Scanln()
47+
48+
auth, err := client.Authorize(ctx, requestToken)
49+
if err != nil {
50+
log.Fatal(err)
51+
}
52+
53+
// Добавка нового элемента пользователю
54+
_ = client.Add(ctx, pocket.AddInput{
55+
AccessToken: auth.AccessToken,
56+
URL: "https://github.com",
57+
})
58+
59+
// Получение всех элементов пользователя
60+
items, _ := client.Retrieving(ctx, pocket.RetrievingInput{
61+
AccessToken: auth.AccessToken,
62+
Favorite: "0",
63+
})
64+
65+
for _, v := range items {
66+
// Модифицирование всех найденных элементов пользователя
67+
actions := []pocket.Action{
68+
{Name: pocket.Favorite, ItemId: v.ItemId, Time: time.Now().Unix()},
69+
{Name: pocket.Archive, ItemId: v.ItemId, Time: time.Now().Unix()},
70+
{Name: pocket.TagsAdd, ItemId: v.ItemId, Tags: "github.com, github, system-version-control"},
71+
}
72+
73+
_ = client.Modify(ctx, pocket.ModifyInput{
74+
AccessToken: auth.AccessToken,
75+
Actions: actions,
76+
})
77+
}
78+
}
79+
```

‎action.go‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
package go_pocket_sdk
2+
3+
const (
4+
Add = "add"
5+
Archive = "archive"
6+
ReAdd = "readd"
7+
Favorite = "favorite"
8+
UnFavorite = "unfavorite"
9+
Delete = "delete"
10+
TagsAdd = "tags_add"
11+
TagsRemove = "tags_remove"
12+
TagsReplace = "tags_replace"
13+
TagsClear = "tags_clear"
14+
TagRename = "tag_rename"
15+
TagDelete = "tag_delete"
16+
)
17+
18+
type Action struct {
19+
Name string `json:"action"`
20+
ItemId string `json:"item_id"`
21+
RefId string `json:"ref_id,omitempty"`
22+
Tags string `json:"tags,omitempty"`
23+
Time int64 `json:"time,omitempty"`
24+
Title string `json:"title,omitempty"`
25+
Url string `json:"url,omitempty"`
26+
OldTag string `json:"old_tag,omitempty"`
27+
NewTag string `json:"new_tag,omitempty"`
28+
}

‎go.mod‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
module github.com/Lapp-coder/go-pocket-sdk
2+
3+
go 1.16
4+
5+
require (
6+
github.com/stretchr/testify v1.7.0
7+
github.com/valyala/fastjson v1.6.3
8+
)

‎go.sum‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
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 h1:4G4v2dO3VZwixGIRoQ5Lfboy6nUhCyYzaqnIAPPhYs4=
6+
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
7+
github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
8+
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
9+
github.com/valyala/fastjson v1.6.3 h1:tAKFnnwmeMGPbwJ7IwxcTPCNr3uIzoIj3/Fh90ra4xc=
10+
github.com/valyala/fastjson v1.6.3/go.mod h1:CLCAqky6SMuOcxStkYQvblddUtoRxhYMGLrsQns1aXY=
11+
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
12+
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
13+
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

‎input.go‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
package go_pocket_sdk
2+
3+
import (
4+
"errors"
5+
"strings"
6+
)
7+
8+
// AddInput contains the data needed to create an item in the Pocket list
9+
type AddInput struct {
10+
AccessToken string
11+
URL string
12+
Title string
13+
Tags []string
14+
TweetId string
15+
}
16+
17+
// ModifyInput contains the data needed to modify items in the Pocket list
18+
type ModifyInput struct {
19+
AccessToken string
20+
Actions []Action
21+
}
22+
23+
// RetrievingInput contains the data needed to retrieve items from the Pocket list
24+
type RetrievingInput struct {
25+
AccessToken string
26+
State string
27+
Favorite string
28+
Tag string
29+
ContentType string
30+
Sort string
31+
DetailType string
32+
Search string
33+
Domain string
34+
Since int64
35+
Count int
36+
Offset int
37+
}
38+
39+
func (ai AddInput) generateRequest(consumerKey string) (requestAdd, error) {
40+
if ai.AccessToken == "" {
41+
return requestAdd{}, errors.New("empty access token")
42+
}
43+
44+
if ai.URL == "" {
45+
return requestAdd{}, errors.New("empty URL")
46+
}
47+
48+
return requestAdd{
49+
ConsumerKey: consumerKey,
50+
AccessToken: ai.AccessToken,
51+
URL: ai.URL,
52+
Title: ai.Title,
53+
Tags: strings.Join(ai.Tags, ", "),
54+
TweetId: ai.TweetId,
55+
}, nil
56+
}
57+
58+
func (mi ModifyInput) generateRequest(consumerKey string) (requestModify, error) {
59+
if mi.AccessToken == "" {
60+
return requestModify{}, errors.New("empty access token")
61+
}
62+
63+
if len(mi.Actions) == 0 {
64+
return requestModify{}, errors.New("no actions to modify")
65+
}
66+
67+
return requestModify{
68+
ConsumerKey: consumerKey,
69+
AccessToken: mi.AccessToken,
70+
Actions: mi.Actions,
71+
}, nil
72+
}
73+
74+
func (ri RetrievingInput) generateRequest(consumerKey string) (requestRetrieving, error) {
75+
if ri.AccessToken == "" {
76+
return requestRetrieving{}, errors.New("empty access token")
77+
}
78+
79+
return requestRetrieving{
80+
ConsumerKey: consumerKey,
81+
AccessToken: ri.AccessToken,
82+
State: ri.State,
83+
Favorite: ri.Favorite,
84+
Tag: ri.Tag,
85+
ContentType: ri.ContentType,
86+
Sort: ri.Sort,
87+
DetailType: ri.DetailType,
88+
Search: ri.Search,
89+
Domain: ri.Domain,
90+
Since: ri.Since,
91+
Count: ri.Count,
92+
Offset: ri.Offset,
93+
}, nil
94+
}

0 commit comments

Comments
 (0)