Compare commits
No commits in common. "master" and "v1.0.0" have entirely different histories.
22 changed files with 202 additions and 979 deletions
54
.github/workflows/ci.yml
vendored
54
.github/workflows/ci.yml
vendored
|
|
@ -1,54 +0,0 @@
|
|||
name: ci
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- '**'
|
||||
tags-ignore:
|
||||
- '*.*'
|
||||
pull_request:
|
||||
|
||||
env:
|
||||
GO111MODULE: on
|
||||
|
||||
jobs:
|
||||
golangci:
|
||||
name: lint
|
||||
if: ${{ github.event_name == 'pull_request' }}
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Check out code into the Go module directory
|
||||
uses: actions/checkout@v2
|
||||
- name: Set up Go 1.17
|
||||
uses: actions/setup-go@v2
|
||||
with:
|
||||
# TODO: Should migrate to 1.18 later
|
||||
go-version: '1.17'
|
||||
- name: Get dependencies
|
||||
run: go mod tidy
|
||||
- name: Lint code with golangci-lint
|
||||
uses: golangci/golangci-lint-action@v3
|
||||
with:
|
||||
version: v1.50.1
|
||||
only-new-issues: true
|
||||
tests:
|
||||
name: Tests
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
matrix:
|
||||
go-version: ['1.13', '1.14', '1.15', '1.16', '1.17']
|
||||
steps:
|
||||
- name: Set up Go ${{ matrix.go-version }}
|
||||
uses: actions/setup-go@v2
|
||||
with:
|
||||
go-version: ${{ matrix.go-version }}
|
||||
- name: Check out code into the Go module directory
|
||||
uses: actions/checkout@v2
|
||||
- name: Get dependencies
|
||||
run: go mod tidy
|
||||
- name: Tests
|
||||
run: |
|
||||
go test -v ./...
|
||||
go build ./examples/...
|
||||
- name: Coverage
|
||||
run: bash <(curl -s https://codecov.io/bash)
|
||||
3
.gitignore
vendored
3
.gitignore
vendored
|
|
@ -6,7 +6,6 @@
|
|||
# Folders
|
||||
_obj
|
||||
_test
|
||||
.idea
|
||||
|
||||
# Architecture specific extensions/prefixes
|
||||
*.[568vq]
|
||||
|
|
@ -26,5 +25,3 @@ _testmain.go
|
|||
|
||||
# Configuration
|
||||
cmd/bot/config.json
|
||||
|
||||
.idea
|
||||
|
|
|
|||
205
.golangci.yml
205
.golangci.yml
|
|
@ -1,205 +0,0 @@
|
|||
run:
|
||||
skip-dirs-use-default: true
|
||||
allow-parallel-runners: true
|
||||
|
||||
output:
|
||||
format: colored-line-number
|
||||
sort-results: true
|
||||
|
||||
# Linters below do not support go1.18 yet because of generics.
|
||||
# See https://github.com/golangci/golangci-lint/issues/2649
|
||||
# - bodyclose
|
||||
# - sqlclosecheck
|
||||
|
||||
linters:
|
||||
disable-all: true
|
||||
enable:
|
||||
- paralleltest
|
||||
- tparallel
|
||||
- asciicheck
|
||||
- asasalint
|
||||
- varnamelen
|
||||
- reassign
|
||||
- nilnil
|
||||
- nilerr
|
||||
- nakedret
|
||||
- goprintffuncname
|
||||
- typecheck
|
||||
- errchkjson
|
||||
- errcheck
|
||||
- gosimple
|
||||
- govet
|
||||
- ineffassign
|
||||
- staticcheck
|
||||
- unused
|
||||
- unparam
|
||||
- dogsled
|
||||
- dupl
|
||||
- errorlint
|
||||
- exhaustive
|
||||
- exportloopref
|
||||
- funlen
|
||||
- gocognit
|
||||
- goconst
|
||||
- gocritic
|
||||
- gocyclo
|
||||
- godot
|
||||
- goimports
|
||||
- revive
|
||||
- gosec
|
||||
- lll
|
||||
- makezero
|
||||
- misspell
|
||||
- nestif
|
||||
- prealloc
|
||||
- predeclared
|
||||
- exportloopref
|
||||
- unconvert
|
||||
- whitespace
|
||||
|
||||
linters-settings:
|
||||
govet:
|
||||
check-shadowing: false
|
||||
disable-all: true
|
||||
enable:
|
||||
- assign
|
||||
- atomic
|
||||
- atomicalign
|
||||
- bools
|
||||
- buildtag
|
||||
- copylocks
|
||||
- fieldalignment
|
||||
- httpresponse
|
||||
- loopclosure
|
||||
- lostcancel
|
||||
- printf
|
||||
- shift
|
||||
- stdmethods
|
||||
- structtag
|
||||
- tests
|
||||
- unmarshal
|
||||
- unreachable
|
||||
- unsafeptr
|
||||
settings:
|
||||
printf:
|
||||
funcs:
|
||||
- (*log.Logger).Fatal
|
||||
- (*log.Logger).Fatalf
|
||||
- (*log.Logger).Fatalln
|
||||
- (*log.Logger).Panic
|
||||
- (*log.Logger).Panicf
|
||||
- (*log.Logger).Panicln
|
||||
- (*log.Logger).Print
|
||||
- (*log.Logger).Printf
|
||||
- (*log.Logger).Println
|
||||
- (*testing.common).Error
|
||||
- (*testing.common).Errorf
|
||||
- (*testing.common).Fatal
|
||||
- (*testing.common).Fatalf
|
||||
- (*testing.common).Log
|
||||
- (*testing.common).Logf
|
||||
- (*testing.common).Skip
|
||||
- (*testing.common).Skipf
|
||||
- (testing.TB).Error
|
||||
- (testing.TB).Errorf
|
||||
- (testing.TB).Fatal
|
||||
- (testing.TB).Fatalf
|
||||
- (testing.TB).Log
|
||||
- (testing.TB).Logf
|
||||
- (testing.TB).Skip
|
||||
- (testing.TB).Skipf
|
||||
- fmt.Errorf
|
||||
- fmt.Fprint
|
||||
- fmt.Fprintf
|
||||
- fmt.Fprintln
|
||||
- fmt.Print
|
||||
- fmt.Printf
|
||||
- fmt.Println
|
||||
- fmt.Sprint
|
||||
- fmt.Sprintf
|
||||
- fmt.Sprintln
|
||||
- log.Fatal
|
||||
- log.Fatalf
|
||||
- log.Fatalln
|
||||
- log.Panic
|
||||
- log.Panicf
|
||||
- log.Panicln
|
||||
- log.Print
|
||||
- log.Printf
|
||||
- log.Println
|
||||
- runtime/trace.Logf
|
||||
unused:
|
||||
check-exported: false
|
||||
unparam:
|
||||
check-exported: false
|
||||
dogsled:
|
||||
max-blank-identifiers: 3
|
||||
dupl:
|
||||
threshold: 200
|
||||
errorlint:
|
||||
errorf: true
|
||||
asserts: false
|
||||
comparison: false
|
||||
exhaustive:
|
||||
check-generated: false
|
||||
default-signifies-exhaustive: false
|
||||
funlen:
|
||||
lines: 90
|
||||
statements: 40
|
||||
gocognit:
|
||||
min-complexity: 25
|
||||
gocyclo:
|
||||
min-complexity: 25
|
||||
goimports:
|
||||
local-prefixes: github.com/retailcrm/messenger
|
||||
lll:
|
||||
line-length: 120
|
||||
misspell:
|
||||
locale: US
|
||||
nestif:
|
||||
min-complexity: 4
|
||||
whitespace:
|
||||
multi-if: false
|
||||
multi-func: false
|
||||
varnamelen:
|
||||
max-distance: 10
|
||||
ignore-map-index-ok: true
|
||||
ignore-type-assert-ok: true
|
||||
ignore-chan-recv-ok: true
|
||||
ignore-decls:
|
||||
- t *testing.T
|
||||
- e error
|
||||
- i int
|
||||
issues:
|
||||
exclude-rules:
|
||||
- path: _test\.go
|
||||
linters:
|
||||
- lll
|
||||
- errcheck
|
||||
- misspell
|
||||
- ineffassign
|
||||
- whitespace
|
||||
- makezero
|
||||
- errcheck
|
||||
- funlen
|
||||
- goconst
|
||||
- gocognit
|
||||
- gocyclo
|
||||
- godot
|
||||
- unused
|
||||
- errchkjson
|
||||
- varnamelen
|
||||
- path: \.go
|
||||
text: "Error return value of `io.WriteString` is not checked"
|
||||
exclude-use-default: true
|
||||
exclude-case-sensitive: false
|
||||
max-issues-per-linter: 0
|
||||
max-same-issues: 0
|
||||
fix: true
|
||||
|
||||
severity:
|
||||
default-severity: error
|
||||
case-sensitive: false
|
||||
|
||||
service:
|
||||
golangci-lint-version: 1.50.x
|
||||
11
.travis.yml
Normal file
11
.travis.yml
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
language: go
|
||||
go:
|
||||
- 1.10.x
|
||||
- master
|
||||
|
||||
go_import_path: github.com/paked/messenger
|
||||
|
||||
install: go get -t ./...
|
||||
script:
|
||||
- go test -v ./...
|
||||
- go build ./examples/...
|
||||
30
README.md
30
README.md
|
|
@ -1,14 +1,8 @@
|
|||
# Messenger
|
||||
[](https://github.com/retailcrm/messenger/actions)
|
||||
[](https://codecov.io/gh/retailcrm/messenger)
|
||||
[](https://github.com/retailcrm/messenger/releases)
|
||||
[](https://goreportcard.com/report/github.com/retailcrm/messenger)
|
||||
[](https://golang.org/dl/)
|
||||
[](https://pkg.go.dev/github.com/retailcrm/messenger)
|
||||
# Messenger [](https://godoc.org/github.com/paked/messenger) [](https://travis-ci.org/paked/messenger)
|
||||
|
||||
This is a Go library for making bots to be used on Facebook messenger. It is built on the [Messenger Platform](https://developers.facebook.com/docs/messenger-platform). One of the main goals of the project is to implement it in an idiomatic and easy to use fashion.
|
||||
|
||||
You can find [examples for this library here](https://github.com/retailcrm/messenger/blob/master/examples/).
|
||||
You can find [examples for this library here](https://github.com/paked/messenger/blob/master/examples/).
|
||||
|
||||
## Tips
|
||||
|
||||
|
|
@ -16,9 +10,27 @@ You can find [examples for this library here](https://github.com/retailcrm/messe
|
|||
- You need a Facebook development app, and a Facebook page in order to build things.
|
||||
- Use [ngrok](https://ngrok.com) to tunnel your locally running bot so that Facebook can reach the webhook.
|
||||
|
||||
## Breaking Changes
|
||||
|
||||
`paked/messenger` is a pretty stable library however, changes will be made which might break backwards compatibility. For the convenience of its users, these are documented here.
|
||||
|
||||
|
||||
- 06/2/18: Added messaging_type field for message send API request as it is required by FB
|
||||
- [23/1/17](https://github.com/paked/messenger/commit/1145fe35249f8ce14d3c0a52544e4a4babdc15a4): Updating timezone type to `float64` in profile struct
|
||||
- [12/9/16](https://github.com/paked/messenger/commit/47f193fc858e2d710c061e88b12dbd804a399e57): Removing unused parameter `text string` from function `(r *Response) GenericTemplate`.
|
||||
- [20/5/16](https://github.com/paked/messenger/commit/1dc4bcc67dec50e2f58436ffbc7d61ca9da5b943): Leaving the `WebhookURL` field blank in `Options` will yield a URL of "/" instead of a panic.
|
||||
- [4/5/16](https://github.com/paked/messenger/commit/eb0e72a5dcd3bfaffcfe88dced6d6ac5247f9da1): The URL to use for the webhook is changable in the `Options` struct.
|
||||
|
||||
## Inspiration
|
||||
|
||||
Messenger takes design cues from:
|
||||
|
||||
- [`net/http`](https://godoc.org/net/http)
|
||||
- [`github.com/nickvanw/ircx`](https://github.com/nickvanw/ircx)
|
||||
|
||||
## Projects
|
||||
|
||||
This is a list of projects use `messenger`. If you would like to add your own, submit a [Pull Request](https://github.com/retailcrm/messenger/pulls/new) adding it below.
|
||||
This is a list of projects use `messenger`. If you would like to add your own, submit a [Pull Request](https://github.com/paked/messenger/pulls/new) adding it below.
|
||||
|
||||
- [meme-maker](https://github.com/paked/meme-maker) by @paked: A bot which, given a photo and a caption, will create a macro meme.
|
||||
- [drone-facebook](https://github.com/appleboy/drone-facebook) by @appleboy: [Drone.io](https://drone.io) plugin which sends Facebook notifications
|
||||
|
|
|
|||
23
actions.go
23
actions.go
|
|
@ -14,30 +14,13 @@ const (
|
|||
// ReadAction means that the event was a previous recipient reading their respective
|
||||
// messages.
|
||||
ReadAction
|
||||
// PostBackAction represents post call back.
|
||||
// PostBackAction represents post call back
|
||||
PostBackAction
|
||||
// OptInAction represents opting in through the Send to Messenger button.
|
||||
// OptInAction represents opting in through the Send to Messenger button
|
||||
OptInAction
|
||||
// ReferralAction represents ?ref parameter in m.me URLs.
|
||||
// ReferralAction represents ?ref parameter in m.me URLs
|
||||
ReferralAction
|
||||
// AccountLinkingAction means that the event concerns changes in account linking
|
||||
// status.
|
||||
AccountLinkingAction
|
||||
)
|
||||
|
||||
// SenderAction is used to send a specific action (event) to the Facebook.
|
||||
// The result of sending said action is supposed to give more interactivity to the bot.
|
||||
type SenderAction string
|
||||
|
||||
const (
|
||||
// MarkSeen marks message as seen.
|
||||
MarkSeen SenderAction = "MARK_SEEN"
|
||||
// TypingOn turns on "Bot is typing..." indicator.
|
||||
TypingOn SenderAction = "TYPING_ON"
|
||||
// TypingOff turns off typing indicator.
|
||||
TypingOff SenderAction = "TYPING_OFF"
|
||||
// React to the message.
|
||||
React SenderAction = "REACT"
|
||||
// Unreact to the message (remove reaction).
|
||||
Unreact SenderAction = "UNREACT"
|
||||
)
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ import (
|
|||
"os"
|
||||
"time"
|
||||
|
||||
"github.com/retailcrm/messenger"
|
||||
"github.com/paked/messenger"
|
||||
)
|
||||
|
||||
var (
|
||||
|
|
@ -48,7 +48,7 @@ func main() {
|
|||
fmt.Println("Something went wrong!", err)
|
||||
}
|
||||
|
||||
r.Text(fmt.Sprintf("Hello, %v!", p.FirstName), messenger.ResponseType, "")
|
||||
r.Text(fmt.Sprintf("Hello, %v!", p.FirstName), messenger.ResponseType)
|
||||
})
|
||||
|
||||
// Setup a handler to be triggered when a message is delivered
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ import (
|
|||
"os"
|
||||
"time"
|
||||
|
||||
"github.com/retailcrm/messenger"
|
||||
"github.com/paked/messenger"
|
||||
)
|
||||
|
||||
var (
|
||||
|
|
@ -57,7 +57,7 @@ func main() {
|
|||
fmt.Println("Something went wrong!", err)
|
||||
}
|
||||
|
||||
r.Text(fmt.Sprintf("Hello, %v!", p.FirstName), messenger.ResponseType, "")
|
||||
r.Text(fmt.Sprintf("Hello, %v!", p.FirstName), messenger.ResponseType)
|
||||
})
|
||||
|
||||
addr := fmt.Sprintf("%s:%d", *host, *port)
|
||||
|
|
|
|||
|
|
@ -11,12 +11,13 @@ import (
|
|||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/retailcrm/messenger"
|
||||
"github.com/paked/messenger"
|
||||
)
|
||||
|
||||
const (
|
||||
webhooksPath = "/webhooks"
|
||||
loginPath = "/signin"
|
||||
logoutPath = "/signout"
|
||||
|
||||
validUsername = "john"
|
||||
validPassword = "secret"
|
||||
|
|
@ -84,7 +85,7 @@ func main() {
|
|||
text = "You've been logged out of your account."
|
||||
}
|
||||
|
||||
if _, err := r.Text(text, messenger.ResponseType, ""); err != nil {
|
||||
if err := r.Text(text, messenger.ResponseType); err != nil {
|
||||
log.Println("Failed to send account linking feedback")
|
||||
}
|
||||
})
|
||||
|
|
@ -116,8 +117,7 @@ func loginButton(r *messenger.Response) error {
|
|||
URL: "https://" + path.Join(*publicHost, loginPath),
|
||||
},
|
||||
}
|
||||
_, err := r.ButtonTemplate("Link your account.", buttons, messenger.ResponseType, "")
|
||||
return err
|
||||
return r.ButtonTemplate("Link your account.", buttons, messenger.ResponseType)
|
||||
}
|
||||
|
||||
// logoutButton show to the user a button that can be used to start
|
||||
|
|
@ -128,14 +128,12 @@ func logoutButton(r *messenger.Response) error {
|
|||
Type: "account_unlink",
|
||||
},
|
||||
}
|
||||
_, err := r.ButtonTemplate("Unlink your account.", buttons, messenger.ResponseType, "")
|
||||
return err
|
||||
return r.ButtonTemplate("Unlink your account.", buttons, messenger.ResponseType)
|
||||
}
|
||||
|
||||
// greeting salutes the user.
|
||||
func greeting(p messenger.Profile, r *messenger.Response) error {
|
||||
_, err := r.Text(fmt.Sprintf("Hello, %v!", p.FirstName), messenger.ResponseType, "")
|
||||
return err
|
||||
return r.Text(fmt.Sprintf("Hello, %v!", p.FirstName), messenger.ResponseType)
|
||||
}
|
||||
|
||||
// help displays possibles actions to the user.
|
||||
|
|
@ -156,8 +154,7 @@ func help(p messenger.Profile, r *messenger.Response) error {
|
|||
},
|
||||
}
|
||||
|
||||
_, err := r.TextWithReplies(text, replies, messenger.ResponseType, "")
|
||||
return err
|
||||
return r.TextWithReplies(text, replies, messenger.ResponseType)
|
||||
}
|
||||
|
||||
// loginForm is the endpoint responsible to displays a login
|
||||
|
|
|
|||
8
go.mod
8
go.mod
|
|
@ -1,11 +1,7 @@
|
|||
module github.com/retailcrm/messenger
|
||||
|
||||
require (
|
||||
github.com/stretchr/testify v1.2.2
|
||||
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7
|
||||
)
|
||||
module github.com/paked/messenger
|
||||
|
||||
require (
|
||||
github.com/davecgh/go-spew v1.1.1 // indirect
|
||||
github.com/pmezard/go-difflib v1.0.0 // indirect
|
||||
github.com/stretchr/testify v1.2.2
|
||||
)
|
||||
|
|
|
|||
8
go.sum
8
go.sum
|
|
@ -1,8 +0,0 @@
|
|||
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
|
||||
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
||||
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
||||
github.com/stretchr/testify v1.2.2 h1:bSDNvY7ZPG5RlJ8otE/7V6gMiyenm9RtJ7IUVIAoJ1w=
|
||||
github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
|
||||
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7 h1:9zdDQZ7Thm29KFXgAX/+yaf3eVbP7djjWp/dXAppNCc=
|
||||
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||
92
message.go
92
message.go
|
|
@ -1,9 +1,6 @@
|
|||
package messenger
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"time"
|
||||
)
|
||||
import "time"
|
||||
|
||||
// Message represents a Facebook messenger message.
|
||||
type Message struct {
|
||||
|
|
@ -16,8 +13,6 @@ type Message struct {
|
|||
// Message is mine
|
||||
IsEcho bool `json:"is_echo,omitempty"`
|
||||
// Mid is the ID of the message.
|
||||
Metadata string `json:"metadata"`
|
||||
// Mid is the ID of the message.
|
||||
Mid string `json:"mid"`
|
||||
// Seq is order the message was sent in relation to other messages.
|
||||
Seq int `json:"seq"`
|
||||
|
|
@ -30,21 +25,6 @@ type Message struct {
|
|||
Attachments []Attachment `json:"attachments"`
|
||||
// Selected quick reply
|
||||
QuickReply *QuickReply `json:"quick_reply,omitempty"`
|
||||
// Entities for NLP
|
||||
// https://developers.facebook.com/docs/messenger-platform/built-in-nlp/
|
||||
NLP json.RawMessage `json:"nlp"`
|
||||
// Read Instagram message data to which this reply was sent to.
|
||||
Read *IGMessageRead `json:"read,omitempty"`
|
||||
// Reaction represents reaction to Instagram message.
|
||||
Reaction *IGMessageReaction `json:"reaction,omitempty"`
|
||||
// Referral with Instagram product data.
|
||||
Referral *IGMessageReferral `json:"referral,omitempty"`
|
||||
// IsUnsupported is being sent if Instagram message is not supported.
|
||||
IsUnsupported bool `json:"is_unsupported,omitempty"`
|
||||
// IsDeleted is being sent if message was deleted.
|
||||
IsDeleted bool `json:"is_deleted,omitempty"`
|
||||
// ReplyTo the Instagram story or to the message.
|
||||
ReplyTo *IGReplyTo `json:"reply_to"`
|
||||
}
|
||||
|
||||
// Delivery represents a the event fired when Facebook delivers a message to the
|
||||
|
|
@ -66,67 +46,9 @@ type Read struct {
|
|||
RawWatermark int64 `json:"watermark"`
|
||||
// Seq is the sequence the message was sent in.
|
||||
Seq int `json:"seq"`
|
||||
// Mid is the ID of the message.
|
||||
Mid string `json:"mid"`
|
||||
}
|
||||
|
||||
// IGMessageRead represents data with the read message ID. Present in the Instagram webhook.
|
||||
type IGMessageRead struct {
|
||||
// Mid is a message ID.
|
||||
Mid string `json:"mid"`
|
||||
}
|
||||
|
||||
// IGMessageReaction represents reaction to the Instagram message.
|
||||
type IGMessageReaction struct {
|
||||
// Mid is a message ID.
|
||||
Mid string `json:"mid"`
|
||||
// Action can be {react|unreact}
|
||||
Action ReactionAction `json:"action"`
|
||||
// Reaction is a reaction name. Optional.
|
||||
Reaction string `json:"reaction,omitempty"`
|
||||
// Emoji is optional.
|
||||
Emoji string `json:"emoji,omitempty"`
|
||||
}
|
||||
|
||||
// IGMessageProduct represents Instagram product.
|
||||
type IGMessageProduct struct {
|
||||
// ID of the product.
|
||||
ID string `json:"id,omitempty"`
|
||||
}
|
||||
|
||||
// IGMessageReferral represents Instagram message referral with ad data and product ID.
|
||||
type IGMessageReferral struct {
|
||||
// Ad data
|
||||
Referral
|
||||
// Product data.
|
||||
Product IGMessageProduct `json:"product,omitempty"`
|
||||
}
|
||||
|
||||
// IGPostback represents Instagram postback webhook data.
|
||||
type IGPostback struct {
|
||||
// Selected icebreaker question or title for the CTA (Generic Template)
|
||||
Title string `json:"title,omitempty"`
|
||||
// Payload is user defined payload.
|
||||
Payload string `json:"payload"`
|
||||
}
|
||||
|
||||
// IGReplyTo represents data of the thing to what reply has been sent.
|
||||
type IGReplyTo struct {
|
||||
// Mid is a message ID to which reply was sent.
|
||||
Mid string `json:"mid"`
|
||||
// Story data.
|
||||
Story *IGReplyToStory `json:"story,omitempty"`
|
||||
}
|
||||
|
||||
// IGReplyToStory is a story data to which reply has been sent.
|
||||
type IGReplyToStory struct {
|
||||
// URL of the story.
|
||||
URL string `json:"url,omitempty"`
|
||||
// ID of the story.
|
||||
ID string `json:"id,omitempty"`
|
||||
}
|
||||
|
||||
// PostBack represents postback callback.
|
||||
// PostBack represents postback callback
|
||||
type PostBack struct {
|
||||
// Sender is who the message was sent from.
|
||||
Sender Sender `json:"-"`
|
||||
|
|
@ -138,10 +60,6 @@ type PostBack struct {
|
|||
Payload string `json:"payload"`
|
||||
// Optional referral info
|
||||
Referral Referral `json:"referral"`
|
||||
// Title for the CTA that was clicked on
|
||||
Title string `json:"title"`
|
||||
// Message ID
|
||||
Mid string `json:"mid"`
|
||||
}
|
||||
|
||||
type AccountLinking struct {
|
||||
|
|
@ -166,9 +84,3 @@ func (d Delivery) Watermark() time.Time {
|
|||
func (r Read) Watermark() time.Time {
|
||||
return time.Unix(r.RawWatermark/int64(time.Microsecond), 0)
|
||||
}
|
||||
|
||||
// GetNLP simply unmarshals the NLP entities to the given struct and returns
|
||||
// an error if it's not possible.
|
||||
func (m *Message) GetNLP(i interface{}) error {
|
||||
return json.Unmarshal(m.NLP, &i)
|
||||
}
|
||||
|
|
|
|||
168
messenger.go
168
messenger.go
|
|
@ -10,22 +10,16 @@ import (
|
|||
"net/http"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"golang.org/x/xerrors"
|
||||
)
|
||||
|
||||
const (
|
||||
// ProfileURL is the API endpoint used for retrieving profiles.
|
||||
// Used in the form: https://graph.facebook.com/v2.6/<USER_ID>?fields=<PROFILE_FIELDS>&access_token=<PAGE_ACCESS_TOKEN>
|
||||
ProfileURL = "https://graph.facebook.com/v2.6/"
|
||||
|
||||
// ProfileFields is a list of JSON field names which will be populated by the profile query.
|
||||
ProfileFields = "first_name,last_name,profile_pic"
|
||||
|
||||
// SendSettingsURL is API endpoint for saving settings.
|
||||
SendSettingsURL = "https://graph.facebook.com/v2.6/me/thread_settings"
|
||||
|
||||
// MessengerProfileURL is the API endpoint where you set properties that define various aspects of the following Messenger Platform features.
|
||||
// MessengerProfileURL is the API endoint where yout bot set properties that define various aspects of the following Messenger Platform features.
|
||||
// Used in the form https://graph.facebook.com/v2.6/me/messenger_profile?access_token=<PAGE_ACCESS_TOKEN>
|
||||
// https://developers.facebook.com/docs/messenger-platform/reference/messenger-profile-api/
|
||||
MessengerProfileURL = "https://graph.facebook.com/v2.6/me/messenger_profile"
|
||||
|
|
@ -48,8 +42,6 @@ type Options struct {
|
|||
WebhookURL string
|
||||
// Mux is shared mux between several Messenger objects
|
||||
Mux *http.ServeMux
|
||||
// SendAPIVersion is a Send API version
|
||||
SendAPIVersion string
|
||||
}
|
||||
|
||||
// MessageHandler is a handler used for responding to a message containing text.
|
||||
|
|
@ -88,7 +80,6 @@ type Messenger struct {
|
|||
verifyHandler func(http.ResponseWriter, *http.Request)
|
||||
verify bool
|
||||
appSecret string
|
||||
sendAPIVersion string
|
||||
}
|
||||
|
||||
// New creates a new Messenger. You pass in Options in order to affect settings.
|
||||
|
|
@ -98,21 +89,16 @@ func New(mo Options) *Messenger {
|
|||
}
|
||||
|
||||
m := &Messenger{
|
||||
mux: mo.Mux,
|
||||
token: mo.Token,
|
||||
verify: mo.Verify,
|
||||
appSecret: mo.AppSecret,
|
||||
sendAPIVersion: mo.SendAPIVersion,
|
||||
mux: mo.Mux,
|
||||
token: mo.Token,
|
||||
verify: mo.Verify,
|
||||
appSecret: mo.AppSecret,
|
||||
}
|
||||
|
||||
if mo.WebhookURL == "" {
|
||||
mo.WebhookURL = "/"
|
||||
}
|
||||
|
||||
if m.sendAPIVersion == "" {
|
||||
m.sendAPIVersion = DefaultSendAPIVersion
|
||||
}
|
||||
|
||||
m.verifyHandler = newVerifyHandler(mo.VerifyToken)
|
||||
m.mux.HandleFunc(mo.WebhookURL, m.handle)
|
||||
|
||||
|
|
@ -143,17 +129,17 @@ func (m *Messenger) HandleRead(f ReadHandler) {
|
|||
m.readHandlers = append(m.readHandlers, f)
|
||||
}
|
||||
|
||||
// HandlePostBack adds a new PostBackHandler to the Messenger.
|
||||
// HandlePostBack adds a new PostBackHandler to the Messenger
|
||||
func (m *Messenger) HandlePostBack(f PostBackHandler) {
|
||||
m.postBackHandlers = append(m.postBackHandlers, f)
|
||||
}
|
||||
|
||||
// HandleReferral adds a new ReferralHandler to the Messenger.
|
||||
// HandleReferral adds a new ReferralHandler to the Messenger
|
||||
func (m *Messenger) HandleReferral(f ReferralHandler) {
|
||||
m.referralHandlers = append(m.referralHandlers, f)
|
||||
}
|
||||
|
||||
// HandleAccountLinking adds a new AccountLinkingHandler to the Messenger.
|
||||
// HandleAccountLinking adds a new AccountLinkingHandler to the Messenger
|
||||
func (m *Messenger) HandleAccountLinking(f AccountLinkingHandler) {
|
||||
m.accountLinkingHandlers = append(m.accountLinkingHandlers, f)
|
||||
}
|
||||
|
|
@ -171,7 +157,7 @@ func (m *Messenger) Handler() http.Handler {
|
|||
// - Name
|
||||
// - First Name
|
||||
// - Last Name
|
||||
// - Profile Picture.
|
||||
// - Profile Picture
|
||||
func (m *Messenger) ProfileByID(id int64, profileFields []string) (Profile, error) {
|
||||
p := Profile{}
|
||||
url := fmt.Sprintf("%v%v", ProfileURL, id)
|
||||
|
|
@ -182,6 +168,7 @@ func (m *Messenger) ProfileByID(id int64, profileFields []string) (Profile, erro
|
|||
}
|
||||
|
||||
fields := strings.Join(profileFields, ",")
|
||||
|
||||
req.URL.RawQuery = "fields=" + fields + "&access_token=" + m.token
|
||||
|
||||
client := &http.Client{}
|
||||
|
|
@ -198,24 +185,22 @@ func (m *Messenger) ProfileByID(id int64, profileFields []string) (Profile, erro
|
|||
|
||||
err = json.Unmarshal(content, &p)
|
||||
if err != nil {
|
||||
return p, NewUnmarshalError(err).WithContent(content)
|
||||
return p, err
|
||||
}
|
||||
|
||||
if p == *new(Profile) {
|
||||
qr := QueryResponse{}
|
||||
err = json.Unmarshal(content, &qr)
|
||||
if qr.Error != nil {
|
||||
err = xerrors.Errorf("facebook error: %w", qr.Error)
|
||||
err = fmt.Errorf("Facebook error : %s", qr.Error.Message)
|
||||
}
|
||||
}
|
||||
|
||||
return p, err
|
||||
}
|
||||
|
||||
// GreetingSetting sends settings for greeting.
|
||||
func (m *Messenger) GreetingSetting(text string) (QueryResponse, error) {
|
||||
var qr QueryResponse
|
||||
|
||||
// GreetingSetting sends settings for greeting
|
||||
func (m *Messenger) GreetingSetting(text string) error {
|
||||
d := GreetingSetting{
|
||||
SettingType: "greeting",
|
||||
Greeting: GreetingInfo{
|
||||
|
|
@ -225,12 +210,12 @@ func (m *Messenger) GreetingSetting(text string) (QueryResponse, error) {
|
|||
|
||||
data, err := json.Marshal(d)
|
||||
if err != nil {
|
||||
return qr, err
|
||||
return err
|
||||
}
|
||||
|
||||
req, err := http.NewRequest("POST", SendSettingsURL, bytes.NewBuffer(data))
|
||||
if err != nil {
|
||||
return qr, err
|
||||
return err
|
||||
}
|
||||
|
||||
req.Header.Set("Content-Type", "application/json")
|
||||
|
|
@ -240,17 +225,15 @@ func (m *Messenger) GreetingSetting(text string) (QueryResponse, error) {
|
|||
|
||||
resp, err := client.Do(req)
|
||||
if err != nil {
|
||||
return qr, err
|
||||
return err
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
|
||||
return getFacebookQueryResponse(resp.Body)
|
||||
return checkFacebookError(resp.Body)
|
||||
}
|
||||
|
||||
// CallToActionsSetting sends settings for Get Started or Persistent Menu.
|
||||
func (m *Messenger) CallToActionsSetting(state string, actions []CallToActionsItem) (QueryResponse, error) {
|
||||
var qr QueryResponse
|
||||
|
||||
// CallToActionsSetting sends settings for Get Started or Persistent Menu
|
||||
func (m *Messenger) CallToActionsSetting(state string, actions []CallToActionsItem) error {
|
||||
d := CallToActionsSetting{
|
||||
SettingType: "call_to_actions",
|
||||
ThreadState: state,
|
||||
|
|
@ -259,12 +242,12 @@ func (m *Messenger) CallToActionsSetting(state string, actions []CallToActionsIt
|
|||
|
||||
data, err := json.Marshal(d)
|
||||
if err != nil {
|
||||
return qr, err
|
||||
return err
|
||||
}
|
||||
|
||||
req, err := http.NewRequest("POST", SendSettingsURL, bytes.NewBuffer(data))
|
||||
if err != nil {
|
||||
return qr, err
|
||||
return err
|
||||
}
|
||||
|
||||
req.Header.Set("Content-Type", "application/json")
|
||||
|
|
@ -274,11 +257,11 @@ func (m *Messenger) CallToActionsSetting(state string, actions []CallToActionsIt
|
|||
|
||||
resp, err := client.Do(req)
|
||||
if err != nil {
|
||||
return qr, err
|
||||
return err
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
|
||||
return getFacebookQueryResponse(resp.Body)
|
||||
return checkFacebookError(resp.Body)
|
||||
}
|
||||
|
||||
// handle is the internal HTTP handler for the webhooks.
|
||||
|
|
@ -296,56 +279,47 @@ func (m *Messenger) handle(w http.ResponseWriter, r *http.Request) {
|
|||
|
||||
err := json.Unmarshal(body, &rec)
|
||||
if err != nil {
|
||||
err = xerrors.Errorf("could not decode response: %w", err)
|
||||
fmt.Println(err)
|
||||
fmt.Println("could not decode response:", err)
|
||||
respond(w, http.StatusBadRequest)
|
||||
fmt.Fprintln(w, `{status: 'not ok'}`)
|
||||
return
|
||||
}
|
||||
|
||||
if rec.Object != "page" {
|
||||
fmt.Println("Object is not page, undefined behavior. Got", rec.Object)
|
||||
respond(w, http.StatusUnprocessableEntity)
|
||||
return
|
||||
fmt.Println("Object is not page, undefined behaviour. Got", rec.Object)
|
||||
}
|
||||
|
||||
if m.verify {
|
||||
if err := m.checkIntegrity(r); err != nil {
|
||||
fmt.Println("could not verify request:", err)
|
||||
respond(w, http.StatusUnauthorized)
|
||||
fmt.Fprintln(w, `{status: 'not ok'}`)
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
m.dispatch(rec)
|
||||
|
||||
respond(w, http.StatusAccepted) // We do not return any meaningful response immediately so it should be 202
|
||||
fmt.Fprintln(w, `{status: 'ok'}`)
|
||||
}
|
||||
|
||||
func respond(w http.ResponseWriter, code int) {
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
fmt.Fprintf(w, `{"code": %d, "status": "%s"}`, code, http.StatusText(code))
|
||||
}
|
||||
|
||||
// checkIntegrity checks the integrity of the requests received.
|
||||
// checkIntegrity checks the integrity of the requests received
|
||||
func (m *Messenger) checkIntegrity(r *http.Request) error {
|
||||
if m.appSecret == "" {
|
||||
return xerrors.New("missing app secret")
|
||||
return fmt.Errorf("missing app secret")
|
||||
}
|
||||
|
||||
sigHeader := "X-Hub-Signature"
|
||||
sig := strings.SplitN(r.Header.Get(sigHeader), "=", 2)
|
||||
if len(sig) == 1 {
|
||||
if sig[0] == "" {
|
||||
return xerrors.Errorf("missing %s header", sigHeader)
|
||||
return fmt.Errorf("missing %s header", sigHeader)
|
||||
}
|
||||
return xerrors.Errorf("malformed %s header: %v", sigHeader, strings.Join(sig, "="))
|
||||
return fmt.Errorf("malformed %s header: %v", sigHeader, strings.Join(sig, "="))
|
||||
}
|
||||
|
||||
checkSHA1 := func(body []byte, hash string) error {
|
||||
mac := hmac.New(sha1.New, []byte(m.appSecret))
|
||||
if mac.Write(body); fmt.Sprintf("%x", mac.Sum(nil)) != hash {
|
||||
return xerrors.Errorf("invalid signature: %s", hash)
|
||||
return fmt.Errorf("invalid signature: %s", hash)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
|
@ -359,7 +333,7 @@ func (m *Messenger) checkIntegrity(r *http.Request) error {
|
|||
case "sha1":
|
||||
return checkSHA1(body, sigHash)
|
||||
default:
|
||||
return xerrors.Errorf("unknown %s header encoding, expected sha1: %s", sigHeader, sig[0])
|
||||
return fmt.Errorf("unknown %s header encoding, expected sha1: %s", sigHeader, sig[0])
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -367,16 +341,15 @@ func (m *Messenger) checkIntegrity(r *http.Request) error {
|
|||
func (m *Messenger) dispatch(r Receive) {
|
||||
for _, entry := range r.Entry {
|
||||
for _, info := range entry.Messaging {
|
||||
a := m.classify(info)
|
||||
a := m.classify(info, entry)
|
||||
if a == UnknownAction {
|
||||
fmt.Println("Unknown action:", info)
|
||||
continue
|
||||
}
|
||||
|
||||
resp := &Response{
|
||||
to: Recipient{ID: info.Sender.ID},
|
||||
token: m.token,
|
||||
sendAPIVersion: m.sendAPIVersion,
|
||||
to: Recipient{info.Sender.ID},
|
||||
token: m.token,
|
||||
}
|
||||
|
||||
switch a {
|
||||
|
|
@ -433,50 +406,46 @@ func (m *Messenger) dispatch(r Receive) {
|
|||
}
|
||||
}
|
||||
|
||||
// Response returns new Response object.
|
||||
// Response returns new Response object
|
||||
func (m *Messenger) Response(to int64) *Response {
|
||||
return &Response{
|
||||
to: Recipient{ID: to},
|
||||
token: m.token,
|
||||
sendAPIVersion: m.sendAPIVersion,
|
||||
to: Recipient{to},
|
||||
token: m.token,
|
||||
}
|
||||
}
|
||||
|
||||
// Send will send a textual message to a user. This user must have previously initiated a conversation with the bot.
|
||||
func (m *Messenger) Send(to Recipient, message string, messagingType MessagingType, metadata string, tags ...string) (QueryResponse, error) {
|
||||
return m.SendWithReplies(to, message, nil, messagingType, metadata, tags...)
|
||||
func (m *Messenger) Send(to Recipient, message string, messagingType MessagingType, tags ...string) error {
|
||||
return m.SendWithReplies(to, message, nil, messagingType, tags...)
|
||||
}
|
||||
|
||||
// SendGeneralMessage will send the GenericTemplate message.
|
||||
func (m *Messenger) SendGeneralMessage(to Recipient, elements *[]StructuredMessageElement, messagingType MessagingType, metadata string, tags ...string) (QueryResponse, error) {
|
||||
// SendGeneralMessage will send the GenericTemplate message
|
||||
func (m *Messenger) SendGeneralMessage(to Recipient, elements *[]StructuredMessageElement, messagingType MessagingType, tags ...string) error {
|
||||
r := &Response{
|
||||
token: m.token,
|
||||
to: to,
|
||||
sendAPIVersion: m.sendAPIVersion,
|
||||
token: m.token,
|
||||
to: to,
|
||||
}
|
||||
return r.GenericTemplate(elements, messagingType, metadata, tags...)
|
||||
return r.GenericTemplate(elements, messagingType, tags...)
|
||||
}
|
||||
|
||||
// SendWithReplies sends a textual message to a user, but gives them the option of numerous quick response options.
|
||||
func (m *Messenger) SendWithReplies(to Recipient, message string, replies []QuickReply, messagingType MessagingType, metadata string, tags ...string) (QueryResponse, error) {
|
||||
func (m *Messenger) SendWithReplies(to Recipient, message string, replies []QuickReply, messagingType MessagingType, tags ...string) error {
|
||||
response := &Response{
|
||||
token: m.token,
|
||||
to: to,
|
||||
sendAPIVersion: m.sendAPIVersion,
|
||||
token: m.token,
|
||||
to: to,
|
||||
}
|
||||
|
||||
return response.TextWithReplies(message, replies, messagingType, metadata, tags...)
|
||||
return response.TextWithReplies(message, replies, messagingType, tags...)
|
||||
}
|
||||
|
||||
// Attachment sends an image, sound, video or a regular file to a given recipient.
|
||||
func (m *Messenger) Attachment(to Recipient, dataType AttachmentType, url string, messagingType MessagingType, metadata string, tags ...string) (QueryResponse, error) {
|
||||
func (m *Messenger) Attachment(to Recipient, dataType AttachmentType, url string, messagingType MessagingType, tags ...string) error {
|
||||
response := &Response{
|
||||
token: m.token,
|
||||
to: to,
|
||||
sendAPIVersion: m.sendAPIVersion,
|
||||
token: m.token,
|
||||
to: to,
|
||||
}
|
||||
|
||||
return response.Attachment(dataType, url, messagingType, metadata, tags...)
|
||||
return response.Attachment(dataType, url, messagingType, tags...)
|
||||
}
|
||||
|
||||
// EnableChatExtension set the homepage url required for a chat extension.
|
||||
|
|
@ -508,31 +477,8 @@ func (m *Messenger) EnableChatExtension(homeURL HomeURL) error {
|
|||
return checkFacebookError(resp.Body)
|
||||
}
|
||||
|
||||
func (m *Messenger) SenderAction(to Recipient, action SenderAction) (QueryResponse, error) {
|
||||
response := &Response{
|
||||
token: m.token,
|
||||
to: to,
|
||||
sendAPIVersion: m.sendAPIVersion,
|
||||
}
|
||||
return response.SenderAction(action)
|
||||
}
|
||||
|
||||
func (m *Messenger) InstagramReaction(
|
||||
to Recipient,
|
||||
mid string,
|
||||
action ReactionAction,
|
||||
reaction ...string,
|
||||
) (QueryResponse, error) {
|
||||
response := &Response{
|
||||
token: m.token,
|
||||
to: to,
|
||||
sendAPIVersion: m.sendAPIVersion,
|
||||
}
|
||||
return response.InstagramReaction(mid, action, reaction...)
|
||||
}
|
||||
|
||||
// classify determines what type of message a webhook event is.
|
||||
func (m *Messenger) classify(info MessageInfo) Action {
|
||||
func (m *Messenger) classify(info MessageInfo, e Entry) Action {
|
||||
if info.Message != nil {
|
||||
return TextAction
|
||||
} else if info.Delivery != nil {
|
||||
|
|
@ -551,7 +497,7 @@ func (m *Messenger) classify(info MessageInfo) Action {
|
|||
return UnknownAction
|
||||
}
|
||||
|
||||
// newVerifyHandler returns a function which can be used to handle webhook verification.
|
||||
// newVerifyHandler returns a function which can be used to handle webhook verification
|
||||
func newVerifyHandler(token string) func(w http.ResponseWriter, r *http.Request) {
|
||||
return func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.FormValue("hub.verify_token") == token {
|
||||
|
|
|
|||
|
|
@ -56,7 +56,7 @@ func TestMessenger_Classify(t *testing.T) {
|
|||
},
|
||||
} {
|
||||
t.Run("action "+name, func(t *testing.T) {
|
||||
action := m.classify(test.msgInfo)
|
||||
action := m.classify(test.msgInfo, Entry{})
|
||||
assert.Exactly(t, action, test.expected)
|
||||
})
|
||||
}
|
||||
|
|
@ -106,7 +106,7 @@ func TestMessenger_Dispatch(t *testing.T) {
|
|||
messages := []MessageInfo{
|
||||
{
|
||||
Sender: Sender{111},
|
||||
Recipient: Recipient{ID: 222},
|
||||
Recipient: Recipient{222},
|
||||
// 2018-11-24 21:31:51 UTC + 999ms
|
||||
Timestamp: 1543095111999,
|
||||
Message: &Message{},
|
||||
|
|
@ -138,7 +138,7 @@ func TestMessenger_Dispatch(t *testing.T) {
|
|||
messages := []MessageInfo{
|
||||
{
|
||||
Sender: Sender{111},
|
||||
Recipient: Recipient{ID: 222},
|
||||
Recipient: Recipient{222},
|
||||
// 2018-11-24 21:31:51 UTC + 999ms
|
||||
Timestamp: 1543095111999,
|
||||
Delivery: &Delivery{},
|
||||
|
|
@ -170,7 +170,7 @@ func TestMessenger_Dispatch(t *testing.T) {
|
|||
messages := []MessageInfo{
|
||||
{
|
||||
Sender: Sender{111},
|
||||
Recipient: Recipient{ID: 222},
|
||||
Recipient: Recipient{222},
|
||||
// 2018-11-24 21:31:51 UTC + 999ms
|
||||
Timestamp: 1543095111999,
|
||||
Read: &Read{},
|
||||
|
|
@ -205,7 +205,7 @@ func TestMessenger_Dispatch(t *testing.T) {
|
|||
messages := []MessageInfo{
|
||||
{
|
||||
Sender: Sender{111},
|
||||
Recipient: Recipient{ID: 222},
|
||||
Recipient: Recipient{222},
|
||||
// 2018-11-24 21:31:51 UTC + 999ms
|
||||
Timestamp: 1543095111999,
|
||||
PostBack: &PostBack{},
|
||||
|
|
@ -240,7 +240,7 @@ func TestMessenger_Dispatch(t *testing.T) {
|
|||
messages := []MessageInfo{
|
||||
{
|
||||
Sender: Sender{111},
|
||||
Recipient: Recipient{ID: 222},
|
||||
Recipient: Recipient{222},
|
||||
// 2018-11-24 21:31:51 UTC + 999ms
|
||||
Timestamp: 1543095111999,
|
||||
OptIn: &OptIn{},
|
||||
|
|
@ -275,7 +275,7 @@ func TestMessenger_Dispatch(t *testing.T) {
|
|||
messages := []MessageInfo{
|
||||
{
|
||||
Sender: Sender{111},
|
||||
Recipient: Recipient{ID: 222},
|
||||
Recipient: Recipient{222},
|
||||
// 2018-11-24 21:31:51 UTC + 999ms
|
||||
Timestamp: 1543095111999,
|
||||
ReferralMessage: &ReferralMessage{},
|
||||
|
|
|
|||
|
|
@ -1,7 +0,0 @@
|
|||
package messenger
|
||||
|
||||
type passThreadControl struct {
|
||||
Recipient Recipient `json:"recipient"`
|
||||
TargetAppID int64 `json:"target_app_id"`
|
||||
Metadata string `json:"metadata"`
|
||||
}
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
package messenger
|
||||
|
||||
// Profile is the public information of a Facebook user.
|
||||
// Profile is the public information of a Facebook user
|
||||
type Profile struct {
|
||||
Name string `json:"name"`
|
||||
FirstName string `json:"first_name"`
|
||||
|
|
|
|||
55
receiving.go
55
receiving.go
|
|
@ -35,8 +35,6 @@ type MessageInfo struct {
|
|||
// Delivery is the contents of a message if it is a DeliveryAction.
|
||||
// Nil if it is not a DeliveryAction.
|
||||
Delivery *Delivery `json:"delivery"`
|
||||
// Reaction represents reaction to Instagram message.
|
||||
Reaction *IGMessageReaction `json:"reaction,omitempty"`
|
||||
|
||||
PostBack *PostBack `json:"postback"`
|
||||
|
||||
|
|
@ -60,7 +58,7 @@ type OptIn struct {
|
|||
Ref string `json:"ref"`
|
||||
}
|
||||
|
||||
// ReferralMessage represents referral endpoint.
|
||||
// ReferralMessage represents referral endpoint
|
||||
type ReferralMessage struct {
|
||||
*Referral
|
||||
|
||||
|
|
@ -72,7 +70,7 @@ type ReferralMessage struct {
|
|||
Time time.Time `json:"-"`
|
||||
}
|
||||
|
||||
// Referral represents referral info.
|
||||
// Referral represents referral info
|
||||
type Referral struct {
|
||||
// Data originally passed in the ref param
|
||||
Ref string `json:"ref"`
|
||||
|
|
@ -80,26 +78,6 @@ type Referral struct {
|
|||
Source string `json:"source"`
|
||||
// The identifier dor the referral
|
||||
Type string `json:"type"`
|
||||
// ID of the ad
|
||||
AdID string `json:"ad_id,omitempty"`
|
||||
// The data containing information about the CTM ad, the user initiated the thread from.
|
||||
AdsContextData AdsContextData `json:"ads_context_data,omitempty"`
|
||||
// URI of the site from which the message was sent to the Facebook chat plugin.
|
||||
RefererURI string `json:"referer_uri,omitempty"`
|
||||
}
|
||||
|
||||
// AdsContextData represents data containing information about the CTM ad, the user initiated the thread from.
|
||||
type AdsContextData struct {
|
||||
// Title of the Ad
|
||||
AdTitle string `json:"ad_title"`
|
||||
// Url of the image from the Ad the user is interested
|
||||
PhotoURL string `json:"photo_url,omitempty"`
|
||||
// Thumbnail url of the video from the ad
|
||||
VideoURL string `json:"video_url,omitempty"`
|
||||
// ID of the post
|
||||
PostID string `json:"post_id"`
|
||||
// Product ID from the Ad the user is interested
|
||||
ProductID string `json:"product_id,omitempty"`
|
||||
}
|
||||
|
||||
// Sender is who the message was sent from.
|
||||
|
|
@ -109,15 +87,11 @@ type Sender struct {
|
|||
|
||||
// Recipient is who the message was sent to.
|
||||
type Recipient struct {
|
||||
ID int64 `json:"id,string,omitempty"`
|
||||
PostID string `json:"post_id,omitempty"`
|
||||
CommentID string `json:"comment_id,omitempty"`
|
||||
ID int64 `json:"id,string"`
|
||||
}
|
||||
|
||||
// Attachment is a file which used in a message.
|
||||
type Attachment struct {
|
||||
Title string `json:"title,omitempty"`
|
||||
URL string `json:"url,omitempty"`
|
||||
// Type is what type the message is. (image, video, audio or location)
|
||||
Type string `json:"type"`
|
||||
// Payload is the information for the file which was sent in the attachment.
|
||||
|
|
@ -136,29 +110,16 @@ type QuickReply struct {
|
|||
|
||||
// Payload is the information on where an attachment is.
|
||||
type Payload struct {
|
||||
URL string `json:"url,omitempty"`
|
||||
Title string `json:"title,omitempty"`
|
||||
// URL is where the attachment resides on the internet.
|
||||
URL string `json:"url,omitempty"`
|
||||
// Coordinates is Lat/Long pair of location pin
|
||||
Coordinates *Coordinates `json:"coordinates,omitempty"`
|
||||
TemplateType string `json:"template_type,omitempty"`
|
||||
Buttons []Button `json:"buttons,omitempty"`
|
||||
Coordinates *Coordinates `json:"coordinates,omitempty"`
|
||||
}
|
||||
|
||||
type Button struct {
|
||||
Type string `json:"type,omitempty"`
|
||||
Title string `json:"title,omitempty"`
|
||||
Payload string `json:"payload,omitempty"`
|
||||
URL string `json:"url,omitempty"`
|
||||
WebviewHeightRatio string `json:"webview_height_ratio,omitempty"`
|
||||
MessengerExtensions bool `json:"messenger_extensions,omitempty"`
|
||||
FallbackURL string `json:"fallback_url,omitempty"`
|
||||
WebviewShareButton string `json:"webview_share_button,omitempty"`
|
||||
}
|
||||
|
||||
// Coordinates is a pair of latitude and longitude.
|
||||
// Coordinates is a pair of latitude and longitude
|
||||
type Coordinates struct {
|
||||
// Lat is latitude
|
||||
Lat float64 `json:"lat"`
|
||||
Lat float64 `json:"lat"`
|
||||
// Long is longitude
|
||||
Long float64 `json:"long"`
|
||||
}
|
||||
|
|
|
|||
331
response.go
331
response.go
|
|
@ -12,8 +12,6 @@ import (
|
|||
"net/http"
|
||||
"net/textproto"
|
||||
"strings"
|
||||
|
||||
"golang.org/x/xerrors"
|
||||
)
|
||||
|
||||
// AttachmentType is attachment type.
|
||||
|
|
@ -23,14 +21,8 @@ type TopElementStyle string
|
|||
type ImageAspectRatio string
|
||||
|
||||
const (
|
||||
// DefaultSendAPIVersion is a default Send API version
|
||||
DefaultSendAPIVersion = "v2.11"
|
||||
// SendMessageURL is API endpoint for sending messages.
|
||||
SendMessageURL = "https://graph.facebook.com/%s/me/messages"
|
||||
// ThreadControlURL is the API endpoint for passing thread control.
|
||||
ThreadControlURL = "https://graph.facebook.com/%s/me/pass_thread_control"
|
||||
// InboxPageID is managed by facebook for secondary pass to inbox features: https://developers.facebook.com/docs/messenger-platform/handover-protocol/pass-thread-control
|
||||
InboxPageID = 263902037430900
|
||||
SendMessageURL = "https://graph.facebook.com/v2.11/me/messages"
|
||||
|
||||
// ImageAttachment is image attachment type.
|
||||
ImageAttachment AttachmentType = "image"
|
||||
|
|
@ -41,13 +33,13 @@ const (
|
|||
// FileAttachment is file attachment type.
|
||||
FileAttachment AttachmentType = "file"
|
||||
|
||||
// ResponseType is response messaging type.
|
||||
// ResponseType is response messaging type
|
||||
ResponseType MessagingType = "RESPONSE"
|
||||
// UpdateType is update messaging type.
|
||||
// UpdateType is update messaging type
|
||||
UpdateType MessagingType = "UPDATE"
|
||||
// MessageTagType is message_tag messaging type.
|
||||
// MessageTagType is message_tag messaging type
|
||||
MessageTagType MessagingType = "MESSAGE_TAG"
|
||||
// NonPromotionalSubscriptionType is NON_PROMOTIONAL_SUBSCRIPTION messaging type.
|
||||
// NonPromotionalSubscriptionType is NON_PROMOTIONAL_SUBSCRIPTION messaging type
|
||||
NonPromotionalSubscriptionType MessagingType = "NON_PROMOTIONAL_SUBSCRIPTION"
|
||||
|
||||
// TopElementStyle is compact.
|
||||
|
|
@ -62,60 +54,37 @@ const (
|
|||
)
|
||||
|
||||
// QueryResponse is the response sent back by Facebook when setting up things
|
||||
// like greetings or call-to-actions.
|
||||
// like greetings or call-to-actions
|
||||
type QueryResponse struct {
|
||||
Error *QueryError `json:"error,omitempty"`
|
||||
RecipientID string `json:"recipient_id"`
|
||||
MessageID string `json:"message_id"`
|
||||
Error *QueryError `json:"error,omitempty"`
|
||||
Result string `json:"result,omitempty"`
|
||||
}
|
||||
|
||||
// QueryError is representing an error sent back by Facebook.
|
||||
// QueryError is representing an error sent back by Facebook
|
||||
type QueryError struct {
|
||||
Message string `json:"message"`
|
||||
Type string `json:"type"`
|
||||
Code int `json:"code"`
|
||||
ErrorSubcode int `json:"error_subcode"`
|
||||
FBTraceID string `json:"fbtrace_id"`
|
||||
}
|
||||
|
||||
// QueryError implements error.
|
||||
func (e QueryError) Error() string {
|
||||
return e.Message
|
||||
Message string `json:"message"`
|
||||
Type string `json:"type"`
|
||||
Code int `json:"code"`
|
||||
FBTraceID string `json:"fbtrace_id"`
|
||||
}
|
||||
|
||||
func checkFacebookError(r io.Reader) error {
|
||||
var err error
|
||||
|
||||
qr := QueryResponse{}
|
||||
decoder := json.NewDecoder(r)
|
||||
err = decoder.Decode(&qr)
|
||||
if err != nil {
|
||||
return NewUnmarshalError(err).WithReader(decoder.Buffered())
|
||||
}
|
||||
err = json.NewDecoder(r).Decode(&qr)
|
||||
if qr.Error != nil {
|
||||
return xerrors.Errorf("facebook error: %w", qr.Error)
|
||||
err = fmt.Errorf("Facebook error : %s", qr.Error.Message)
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func getFacebookQueryResponse(r io.Reader) (QueryResponse, error) {
|
||||
qr := QueryResponse{}
|
||||
decoder := json.NewDecoder(r)
|
||||
if err := decoder.Decode(&qr); err != nil {
|
||||
return qr, NewUnmarshalError(err).WithReader(decoder.Buffered())
|
||||
}
|
||||
if qr.Error != nil {
|
||||
return qr, xerrors.Errorf("facebook error: %w", qr.Error)
|
||||
}
|
||||
return qr, nil
|
||||
}
|
||||
|
||||
// Response is used for responding to events with messages.
|
||||
type Response struct {
|
||||
token string
|
||||
to Recipient
|
||||
sendAPIVersion string
|
||||
token string
|
||||
to Recipient
|
||||
}
|
||||
|
||||
// SetToken is for using DispatchMessage from outside.
|
||||
|
|
@ -124,15 +93,14 @@ func (r *Response) SetToken(token string) {
|
|||
}
|
||||
|
||||
// Text sends a textual message.
|
||||
func (r *Response) Text(message string, messagingType MessagingType, metadata string, tags ...string) (QueryResponse, error) {
|
||||
return r.TextWithReplies(message, nil, messagingType, metadata, tags...)
|
||||
func (r *Response) Text(message string, messagingType MessagingType, tags ...string) error {
|
||||
return r.TextWithReplies(message, nil, messagingType, tags...)
|
||||
}
|
||||
|
||||
// TextWithReplies sends a textual message with some replies
|
||||
// messagingType should be one of the following: "RESPONSE","UPDATE","MESSAGE_TAG","NON_PROMOTIONAL_SUBSCRIPTION"
|
||||
// only supply tags when messagingType == "MESSAGE_TAG"
|
||||
// (see https://developers.facebook.com/docs/messenger-platform/send-messages#messaging_types for more).
|
||||
func (r *Response) TextWithReplies(message string, replies []QuickReply, messagingType MessagingType, metadata string, tags ...string) (QueryResponse, error) {
|
||||
// only supply tags when messagingType == "MESSAGE_TAG" (see https://developers.facebook.com/docs/messenger-platform/send-messages#messaging_types for more)
|
||||
func (r *Response) TextWithReplies(message string, replies []QuickReply, messagingType MessagingType, tags ...string) error {
|
||||
var tag string
|
||||
if len(tags) > 0 {
|
||||
tag = tags[0]
|
||||
|
|
@ -145,15 +113,14 @@ func (r *Response) TextWithReplies(message string, replies []QuickReply, messagi
|
|||
Text: message,
|
||||
Attachment: nil,
|
||||
QuickReplies: replies,
|
||||
Metadata: metadata,
|
||||
},
|
||||
Tag: tag,
|
||||
}
|
||||
return r.DispatchMessage(&m)
|
||||
}
|
||||
|
||||
// AttachmentWithReplies sends a attachment message with some replies.
|
||||
func (r *Response) AttachmentWithReplies(attachment *StructuredMessageAttachment, replies []QuickReply, messagingType MessagingType, metadata string, tags ...string) (QueryResponse, error) {
|
||||
// AttachmentWithReplies sends a attachment message with some replies
|
||||
func (r *Response) AttachmentWithReplies(attachment *StructuredMessageAttachment, replies []QuickReply, messagingType MessagingType, tags ...string) error {
|
||||
var tag string
|
||||
if len(tags) > 0 {
|
||||
tag = tags[0]
|
||||
|
|
@ -165,7 +132,6 @@ func (r *Response) AttachmentWithReplies(attachment *StructuredMessageAttachment
|
|||
Message: MessageData{
|
||||
Attachment: attachment,
|
||||
QuickReplies: replies,
|
||||
Metadata: metadata,
|
||||
},
|
||||
Tag: tag,
|
||||
}
|
||||
|
|
@ -173,20 +139,18 @@ func (r *Response) AttachmentWithReplies(attachment *StructuredMessageAttachment
|
|||
}
|
||||
|
||||
// Image sends an image.
|
||||
func (r *Response) Image(im image.Image) (QueryResponse, error) {
|
||||
var qr QueryResponse
|
||||
|
||||
func (r *Response) Image(im image.Image) error {
|
||||
imageBytes := new(bytes.Buffer)
|
||||
err := jpeg.Encode(imageBytes, im, nil)
|
||||
if err != nil {
|
||||
return qr, err
|
||||
return err
|
||||
}
|
||||
|
||||
return r.AttachmentData(ImageAttachment, "meme.jpg", "image/jpeg", imageBytes)
|
||||
return r.AttachmentData(ImageAttachment, "meme.jpg", imageBytes)
|
||||
}
|
||||
|
||||
// Attachment sends an image, sound, video or a regular file to a chat.
|
||||
func (r *Response) Attachment(dataType AttachmentType, url string, messagingType MessagingType, metadata string, tags ...string) (QueryResponse, error) {
|
||||
func (r *Response) Attachment(dataType AttachmentType, url string, messagingType MessagingType, tags ...string) error {
|
||||
var tag string
|
||||
if len(tags) > 0 {
|
||||
tag = tags[0]
|
||||
|
|
@ -196,7 +160,6 @@ func (r *Response) Attachment(dataType AttachmentType, url string, messagingType
|
|||
MessagingType: messagingType,
|
||||
Recipient: r.to,
|
||||
Message: StructuredMessageData{
|
||||
Metadata: metadata,
|
||||
Attachment: StructuredMessageAttachment{
|
||||
Type: dataType,
|
||||
Payload: StructuredMessagePayload{
|
||||
|
|
@ -209,15 +172,15 @@ func (r *Response) Attachment(dataType AttachmentType, url string, messagingType
|
|||
return r.DispatchMessage(&m)
|
||||
}
|
||||
|
||||
// copied from multipart package.
|
||||
// copied from multipart package
|
||||
var quoteEscaper = strings.NewReplacer("\\", "\\\\", `"`, "\\\"")
|
||||
|
||||
// copied from multipart package.
|
||||
// copied from multipart package
|
||||
func escapeQuotes(s string) string {
|
||||
return quoteEscaper.Replace(s)
|
||||
}
|
||||
|
||||
// copied from multipart package with slight changes due to fixed content-type there.
|
||||
// copied from multipart package with slight changes due to fixed content-type there
|
||||
func createFormFile(filename string, w *multipart.Writer, contentType string) (io.Writer, error) {
|
||||
h := make(textproto.MIMEHeader)
|
||||
h.Set("Content-Disposition",
|
||||
|
|
@ -228,33 +191,33 @@ func createFormFile(filename string, w *multipart.Writer, contentType string) (i
|
|||
}
|
||||
|
||||
// AttachmentData sends an image, sound, video or a regular file to a chat via an io.Reader.
|
||||
func (r *Response) AttachmentData(
|
||||
dataType AttachmentType, filename string, contentType string, filedata io.Reader) (QueryResponse, error) {
|
||||
var qr QueryResponse
|
||||
func (r *Response) AttachmentData(dataType AttachmentType, filename string, filedata io.Reader) error {
|
||||
|
||||
filedataBytes, err := ioutil.ReadAll(filedata)
|
||||
if err != nil {
|
||||
return qr, err
|
||||
return err
|
||||
}
|
||||
contentType := http.DetectContentType(filedataBytes[:512])
|
||||
fmt.Println("Content-type detected:", contentType)
|
||||
|
||||
var body bytes.Buffer
|
||||
multipartWriter := multipart.NewWriter(&body)
|
||||
data, err := createFormFile(filename, multipartWriter, contentType)
|
||||
if err != nil {
|
||||
return qr, err
|
||||
return err
|
||||
}
|
||||
|
||||
_, err = bytes.NewBuffer(filedataBytes).WriteTo(data)
|
||||
if err != nil {
|
||||
return qr, err
|
||||
return err
|
||||
}
|
||||
|
||||
multipartWriter.WriteField("recipient", fmt.Sprintf(`{"id":"%v"}`, r.to.ID))
|
||||
multipartWriter.WriteField("message", fmt.Sprintf(`{"attachment":{"type":"%v", "payload":{}}}`, dataType))
|
||||
|
||||
req, err := http.NewRequest("POST", fmt.Sprintf(SendMessageURL, r.sendAPIVersion), &body)
|
||||
req, err := http.NewRequest("POST", SendMessageURL, &body)
|
||||
if err != nil {
|
||||
return qr, err
|
||||
return err
|
||||
}
|
||||
|
||||
req.URL.RawQuery = "access_token=" + r.token
|
||||
|
|
@ -264,15 +227,14 @@ func (r *Response) AttachmentData(
|
|||
client := &http.Client{}
|
||||
resp, err := client.Do(req)
|
||||
if err != nil {
|
||||
return qr, err
|
||||
return err
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
|
||||
return getFacebookQueryResponse(resp.Body)
|
||||
return checkFacebookError(resp.Body)
|
||||
}
|
||||
|
||||
// ButtonTemplate sends a message with the main contents being button elements.
|
||||
func (r *Response) ButtonTemplate(text string, buttons *[]StructuredMessageButton, messagingType MessagingType, metadata string, tags ...string) (QueryResponse, error) {
|
||||
// ButtonTemplate sends a message with the main contents being button elements
|
||||
func (r *Response) ButtonTemplate(text string, buttons *[]StructuredMessageButton, messagingType MessagingType, tags ...string) error {
|
||||
var tag string
|
||||
if len(tags) > 0 {
|
||||
tag = tags[0]
|
||||
|
|
@ -282,7 +244,6 @@ func (r *Response) ButtonTemplate(text string, buttons *[]StructuredMessageButto
|
|||
MessagingType: messagingType,
|
||||
Recipient: r.to,
|
||||
Message: StructuredMessageData{
|
||||
Metadata: metadata,
|
||||
Attachment: StructuredMessageAttachment{
|
||||
Type: "template",
|
||||
Payload: StructuredMessagePayload{
|
||||
|
|
@ -299,8 +260,8 @@ func (r *Response) ButtonTemplate(text string, buttons *[]StructuredMessageButto
|
|||
return r.DispatchMessage(&m)
|
||||
}
|
||||
|
||||
// GenericTemplate is a message which allows for structural elements to be sent.
|
||||
func (r *Response) GenericTemplate(elements *[]StructuredMessageElement, messagingType MessagingType, metadata string, tags ...string) (QueryResponse, error) {
|
||||
// GenericTemplate is a message which allows for structural elements to be sent
|
||||
func (r *Response) GenericTemplate(elements *[]StructuredMessageElement, messagingType MessagingType, tags ...string) error {
|
||||
var tag string
|
||||
if len(tags) > 0 {
|
||||
tag = tags[0]
|
||||
|
|
@ -310,7 +271,6 @@ func (r *Response) GenericTemplate(elements *[]StructuredMessageElement, messagi
|
|||
MessagingType: messagingType,
|
||||
Recipient: r.to,
|
||||
Message: StructuredMessageData{
|
||||
Metadata: metadata,
|
||||
Attachment: StructuredMessageAttachment{
|
||||
Type: "template",
|
||||
Payload: StructuredMessagePayload{
|
||||
|
|
@ -325,34 +285,8 @@ func (r *Response) GenericTemplate(elements *[]StructuredMessageElement, messagi
|
|||
return r.DispatchMessage(&m)
|
||||
}
|
||||
|
||||
// ListTemplate sends a list of elements.
|
||||
func (r *Response) ListTemplate(elements *[]StructuredMessageElement, messagingType MessagingType, tags ...string) (QueryResponse, error) {
|
||||
var tag string
|
||||
if len(tags) > 0 {
|
||||
tag = tags[0]
|
||||
}
|
||||
|
||||
m := SendStructuredMessage{
|
||||
MessagingType: messagingType,
|
||||
Recipient: r.to,
|
||||
Message: StructuredMessageData{
|
||||
Attachment: StructuredMessageAttachment{
|
||||
Type: "template",
|
||||
Payload: StructuredMessagePayload{
|
||||
TopElementStyle: "compact",
|
||||
TemplateType: "list",
|
||||
Buttons: nil,
|
||||
Elements: elements,
|
||||
},
|
||||
},
|
||||
},
|
||||
Tag: tag,
|
||||
}
|
||||
return r.DispatchMessage(&m)
|
||||
}
|
||||
|
||||
// SenderAction sends an info about sender action.
|
||||
func (r *Response) SenderAction(action SenderAction) (QueryResponse, error) {
|
||||
// SenderAction sends a info about sender action
|
||||
func (r *Response) SenderAction(action string) error {
|
||||
m := SendSenderAction{
|
||||
Recipient: r.to,
|
||||
SenderAction: action,
|
||||
|
|
@ -360,62 +294,14 @@ func (r *Response) SenderAction(action SenderAction) (QueryResponse, error) {
|
|||
return r.DispatchMessage(&m)
|
||||
}
|
||||
|
||||
// InstagramReaction sends an info about Instagram reaction.
|
||||
func (r *Response) InstagramReaction(mid string, action ReactionAction, reaction ...string) (QueryResponse, error) {
|
||||
m := SendInstagramReaction{
|
||||
Recipient: r.to,
|
||||
SenderAction: action,
|
||||
Payload: SenderInstagramReactionPayload{
|
||||
MessageID: mid,
|
||||
},
|
||||
}
|
||||
if len(reaction) > 0 {
|
||||
m.Payload.Reaction = reaction[0]
|
||||
}
|
||||
return r.DispatchMessage(&m)
|
||||
}
|
||||
|
||||
// DispatchMessage posts the message to messenger, return the error if there's any.
|
||||
func (r *Response) DispatchMessage(m interface{}) (QueryResponse, error) {
|
||||
var res QueryResponse
|
||||
// DispatchMessage posts the message to messenger, return the error if there's any
|
||||
func (r *Response) DispatchMessage(m interface{}) error {
|
||||
data, err := json.Marshal(m)
|
||||
if err != nil {
|
||||
return res, err
|
||||
}
|
||||
|
||||
req, err := http.NewRequest("POST", fmt.Sprintf(SendMessageURL, r.sendAPIVersion), bytes.NewBuffer(data))
|
||||
if err != nil {
|
||||
return res, err
|
||||
}
|
||||
|
||||
req.Header.Set("Content-Type", "application/json")
|
||||
req.URL.RawQuery = "access_token=" + r.token
|
||||
|
||||
resp, err := http.DefaultClient.Do(req)
|
||||
if err != nil {
|
||||
return res, err
|
||||
}
|
||||
|
||||
defer resp.Body.Close()
|
||||
|
||||
return getFacebookQueryResponse(resp.Body)
|
||||
}
|
||||
|
||||
// PassThreadToInbox Uses Messenger Handover Protocol for live inbox
|
||||
// https://developers.facebook.com/docs/messenger-platform/handover-protocol/#inbox
|
||||
func (r *Response) PassThreadToInbox() error {
|
||||
p := passThreadControl{
|
||||
Recipient: r.to,
|
||||
TargetAppID: InboxPageID,
|
||||
Metadata: "Passing to inbox secondary app",
|
||||
}
|
||||
|
||||
data, err := json.Marshal(p)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
req, err := http.NewRequest("POST", fmt.Sprintf(ThreadControlURL, r.sendAPIVersion), bytes.NewBuffer(data))
|
||||
req, err := http.NewRequest("POST", SendMessageURL, bytes.NewBuffer(data))
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
|
@ -428,7 +314,9 @@ func (r *Response) PassThreadToInbox() error {
|
|||
return err
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
|
||||
if resp.StatusCode == 200 {
|
||||
return nil
|
||||
}
|
||||
return checkFacebookError(resp.Body)
|
||||
}
|
||||
|
||||
|
|
@ -445,7 +333,6 @@ type MessageData struct {
|
|||
Text string `json:"text,omitempty"`
|
||||
Attachment *StructuredMessageAttachment `json:"attachment,omitempty"`
|
||||
QuickReplies []QuickReply `json:"quick_replies,omitempty"`
|
||||
Metadata string `json:"metadata,omitempty"`
|
||||
}
|
||||
|
||||
// SendStructuredMessage is a structured message template.
|
||||
|
|
@ -459,20 +346,17 @@ type SendStructuredMessage struct {
|
|||
// StructuredMessageData is an attachment sent with a structured message.
|
||||
type StructuredMessageData struct {
|
||||
Attachment StructuredMessageAttachment `json:"attachment"`
|
||||
Metadata string `json:"metadata,omitempty"`
|
||||
}
|
||||
|
||||
// StructuredMessageAttachment is the attachment of a structured message.
|
||||
type StructuredMessageAttachment struct {
|
||||
// Type must be template
|
||||
Title string `json:"title,omitempty"`
|
||||
URL string `json:"url,omitempty"`
|
||||
Type AttachmentType `json:"type"`
|
||||
Type AttachmentType `json:"type"`
|
||||
// Payload is the information for the file which was sent in the attachment.
|
||||
Payload StructuredMessagePayload `json:"payload"`
|
||||
}
|
||||
|
||||
// StructuredMessagePayload is the actual payload of an attachment.
|
||||
// StructuredMessagePayload is the actual payload of an attachment
|
||||
type StructuredMessagePayload struct {
|
||||
// TemplateType must be button, generic or receipt
|
||||
TemplateType string `json:"template_type,omitempty"`
|
||||
|
|
@ -483,60 +367,19 @@ type StructuredMessagePayload struct {
|
|||
Elements *[]StructuredMessageElement `json:"elements,omitempty"`
|
||||
Buttons *[]StructuredMessageButton `json:"buttons,omitempty"`
|
||||
Url string `json:"url,omitempty"`
|
||||
AttachmentID string `json:"attachment_id,omitempty"`
|
||||
ReceiptMessagePayload
|
||||
}
|
||||
|
||||
type ReceiptMessagePayload struct {
|
||||
RecipientName string `json:"recipient_name,omitempty"`
|
||||
OrderNumber string `json:"order_number,omitempty"`
|
||||
Currency string `json:"currency,omitempty"`
|
||||
PaymentMethod string `json:"payment_method,omitempty"`
|
||||
Timestamp int64 `json:"timestamp,omitempty"`
|
||||
Address *Address `json:"address,omitempty"`
|
||||
Summary *Summary `json:"summary,omitempty"`
|
||||
Adjustments []Adjustment `json:"adjustments,omitempty"`
|
||||
}
|
||||
|
||||
type Address struct {
|
||||
Street1 string `json:"street_1,omitempty"`
|
||||
Street2 string `json:"street_2,omitempty"`
|
||||
City string `json:"city,omitempty"`
|
||||
PostalCode string `json:"postal_code,omitempty"`
|
||||
State string `json:"state,omitempty"`
|
||||
Country string `json:"country,omitempty"`
|
||||
}
|
||||
|
||||
type Summary struct {
|
||||
Subtotal float32 `json:"subtotal,omitempty"`
|
||||
ShippingCost float32 `json:"shipping_cost,omitempty"`
|
||||
TotalTax float32 `json:"total_tax,omitempty"`
|
||||
TotalCost float32 `json:"total_cost,omitempty"`
|
||||
}
|
||||
|
||||
type Adjustment struct {
|
||||
Name string `json:"name,omitempty"`
|
||||
Amount float32 `json:"amount,omitempty"`
|
||||
}
|
||||
|
||||
// StructuredMessageElement is a response containing structural elements.
|
||||
// StructuredMessageElement is a response containing structural elements
|
||||
type StructuredMessageElement struct {
|
||||
Title string `json:"title"`
|
||||
ImageURL string `json:"image_url"`
|
||||
ItemURL string `json:"item_url,omitempty"`
|
||||
Subtitle string `json:"subtitle"`
|
||||
DefaultAction *DefaultAction `json:"default_action,omitempty"`
|
||||
Buttons *[]StructuredMessageButton `json:"buttons,omitempty"`
|
||||
ReceiptMessageElement
|
||||
Title string `json:"title"`
|
||||
ImageURL string `json:"image_url"`
|
||||
ItemURL string `json:"item_url,omitempty"`
|
||||
Subtitle string `json:"subtitle"`
|
||||
DefaultAction *DefaultAction `json:"default_action,omitempty"`
|
||||
Buttons []StructuredMessageButton `json:"buttons"`
|
||||
}
|
||||
|
||||
type ReceiptMessageElement struct {
|
||||
Quantity float32 `json:"quantity,omitempty"`
|
||||
Price float32 `json:"price,omitempty"`
|
||||
Currency string `json:"currency,omitempty"`
|
||||
}
|
||||
|
||||
// DefaultAction is a response containing default action properties.
|
||||
// DefaultAction is a response containing default action properties
|
||||
type DefaultAction struct {
|
||||
Type string `json:"type"`
|
||||
URL string `json:"url,omitempty"`
|
||||
|
|
@ -546,44 +389,20 @@ type DefaultAction struct {
|
|||
WebviewShareButton string `json:"webview_share_button,omitempty"`
|
||||
}
|
||||
|
||||
// StructuredMessageButton is a response containing buttons.
|
||||
// StructuredMessageButton is a response containing buttons
|
||||
type StructuredMessageButton struct {
|
||||
Type string `json:"type"`
|
||||
URL string `json:"url,omitempty"`
|
||||
Title string `json:"title,omitempty"`
|
||||
Payload string `json:"payload,omitempty"`
|
||||
WebviewHeightRatio string `json:"webview_height_ratio,omitempty"`
|
||||
MessengerExtensions bool `json:"messenger_extensions,omitempty"`
|
||||
FallbackURL string `json:"fallback_url,omitempty"`
|
||||
WebviewShareButton string `json:"webview_share_button,omitempty"`
|
||||
ShareContents *StructuredMessageData `json:"share_contents,omitempty"`
|
||||
Type string `json:"type"`
|
||||
URL string `json:"url,omitempty"`
|
||||
Title string `json:"title,omitempty"`
|
||||
Payload string `json:"payload,omitempty"`
|
||||
WebviewHeightRatio string `json:"webview_height_ratio,omitempty"`
|
||||
MessengerExtensions bool `json:"messenger_extensions,omitempty"`
|
||||
FallbackURL string `json:"fallback_url,omitempty"`
|
||||
WebviewShareButton string `json:"webview_share_button,omitempty"`
|
||||
}
|
||||
|
||||
// SendSenderAction is the information about sender action.
|
||||
// SendSenderAction is the information about sender action
|
||||
type SendSenderAction struct {
|
||||
Recipient Recipient `json:"recipient"`
|
||||
SenderAction SenderAction `json:"sender_action"`
|
||||
}
|
||||
|
||||
// ReactionAction contains info about reaction action type.
|
||||
type ReactionAction string
|
||||
|
||||
const (
|
||||
// ReactionActionReact is used when user added a reaction.
|
||||
ReactionActionReact ReactionAction = "react"
|
||||
// ReactionActionUnReact is used when user removed a reaction.
|
||||
ReactionActionUnReact ReactionAction = "unreact"
|
||||
)
|
||||
|
||||
// SendInstagramReaction is the information about sender action.
|
||||
type SendInstagramReaction struct {
|
||||
Recipient Recipient `json:"recipient"`
|
||||
SenderAction ReactionAction `json:"sender_action"`
|
||||
Payload SenderInstagramReactionPayload `json:"payload"`
|
||||
}
|
||||
|
||||
// SenderInstagramReactionPayload contains target message ID and reaction name.
|
||||
type SenderInstagramReactionPayload struct {
|
||||
MessageID string `json:"message_id"`
|
||||
Reaction string `json:"reaction"`
|
||||
Recipient Recipient `json:"recipient"`
|
||||
SenderAction string `json:"sender_action"`
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,33 +0,0 @@
|
|||
package messenger
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
func Test_MarshalStructuredMessageElement(t *testing.T) {
|
||||
data, err := json.Marshal(StructuredMessageElement{
|
||||
Title: "Title",
|
||||
})
|
||||
require.NoError(t, err)
|
||||
assert.JSONEq(t, string(data), `{"image_url":"", "subtitle":"", "title": "Title"}`)
|
||||
}
|
||||
|
||||
func TestResponse_checkFacebookError_UnmarshalError(t *testing.T) {
|
||||
r := bytes.NewReader([]byte("test error text"))
|
||||
err := checkFacebookError(r)
|
||||
assert.True(t, errors.Is(err, ErrUnmarshal))
|
||||
assert.Contains(t, err.Error(), "test error text")
|
||||
}
|
||||
|
||||
func TestResponse_getFacebookQueryResponse_UnmarshalError(t *testing.T) {
|
||||
r := bytes.NewReader([]byte("test error text"))
|
||||
_, err := getFacebookQueryResponse(r)
|
||||
assert.True(t, errors.Is(err, ErrUnmarshal))
|
||||
assert.Contains(t, err.Error(), "test error text")
|
||||
}
|
||||
|
|
@ -17,25 +17,25 @@ const (
|
|||
WebviewFull = "full"
|
||||
)
|
||||
|
||||
// GreetingSetting is the setting for greeting message.
|
||||
// GreetingSetting is the setting for greeting message
|
||||
type GreetingSetting struct {
|
||||
SettingType string `json:"setting_type"`
|
||||
Greeting GreetingInfo `json:"greeting"`
|
||||
}
|
||||
|
||||
// GreetingInfo contains greeting message.
|
||||
// GreetingInfo contains greeting message
|
||||
type GreetingInfo struct {
|
||||
Text string `json:"text"`
|
||||
}
|
||||
|
||||
// CallToActionsSetting is the settings for Get Started and Persist Menu.
|
||||
// CallToActionsSetting is the settings for Get Started and Persist Menu
|
||||
type CallToActionsSetting struct {
|
||||
SettingType string `json:"setting_type"`
|
||||
ThreadState string `json:"thread_state"`
|
||||
CallToActions []CallToActionsItem `json:"call_to_actions"`
|
||||
}
|
||||
|
||||
// CallToActionsItem contains Get Started button or item of Persist Menu.
|
||||
// CallToActionsItem contains Get Started button or item of Persist Menu
|
||||
type CallToActionsItem struct {
|
||||
Type string `json:"type,omitempty"`
|
||||
Title string `json:"title,omitempty"`
|
||||
|
|
|
|||
|
|
@ -1,47 +0,0 @@
|
|||
package messenger
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"io/ioutil"
|
||||
)
|
||||
|
||||
var ErrUnmarshal = errors.New("unmarshal error")
|
||||
|
||||
type UnmarshalError struct {
|
||||
Content []byte
|
||||
ErrorText string
|
||||
Err error
|
||||
}
|
||||
|
||||
func (u *UnmarshalError) Error() string {
|
||||
return fmt.Sprintf("can not unmarshal content: %s; error: %s", string(u.Content), u.ErrorText)
|
||||
}
|
||||
|
||||
func (u *UnmarshalError) Unwrap() error {
|
||||
return u.Err
|
||||
}
|
||||
|
||||
func NewUnmarshalError(err error) *UnmarshalError {
|
||||
return &UnmarshalError{
|
||||
Err: ErrUnmarshal,
|
||||
ErrorText: err.Error(),
|
||||
}
|
||||
}
|
||||
|
||||
func (u *UnmarshalError) WithReader(reader io.Reader) *UnmarshalError {
|
||||
content, _ := ioutil.ReadAll(reader)
|
||||
u.Content = content
|
||||
return u
|
||||
}
|
||||
|
||||
func (u *UnmarshalError) WithContent(content []byte) *UnmarshalError {
|
||||
u.Content = content
|
||||
return u
|
||||
}
|
||||
|
||||
func (u *UnmarshalError) WithErr(err error) *UnmarshalError {
|
||||
u.Err = err
|
||||
return u
|
||||
}
|
||||
|
|
@ -1,57 +0,0 @@
|
|||
package messenger
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"errors"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
)
|
||||
|
||||
func TestNewUnmarshalError(t *testing.T) {
|
||||
err := errors.New("some error")
|
||||
unmarshalError := NewUnmarshalError(err)
|
||||
assert.True(t, errors.Is(unmarshalError, ErrUnmarshal))
|
||||
}
|
||||
|
||||
func TestUnmarshalError_Error(t *testing.T) {
|
||||
err := errors.New("some error")
|
||||
content := []byte("test content")
|
||||
actual := NewUnmarshalError(err).WithContent(content).Error()
|
||||
expected := "can not unmarshal content: test content; error: some error"
|
||||
assert.Equal(t, expected, actual)
|
||||
}
|
||||
|
||||
func TestUnmarshalError_Unwrap(t *testing.T) {
|
||||
err := errors.New("some error")
|
||||
actual := NewUnmarshalError(err).Unwrap()
|
||||
expected := ErrUnmarshal
|
||||
assert.Equal(t, expected, actual)
|
||||
}
|
||||
|
||||
func TestUnmarshalError_WithContent(t *testing.T) {
|
||||
err := errors.New("some error")
|
||||
content := []byte("test content")
|
||||
|
||||
actual := NewUnmarshalError(err).WithContent(content)
|
||||
expected := &UnmarshalError{Err: ErrUnmarshal, Content: content, ErrorText: err.Error()}
|
||||
assert.Equal(t, expected, actual)
|
||||
}
|
||||
|
||||
func TestUnmarshalError_WithReader(t *testing.T) {
|
||||
err := errors.New("some error")
|
||||
content := []byte("test content")
|
||||
reader := bytes.NewReader(content)
|
||||
|
||||
actual := NewUnmarshalError(err).WithReader(reader)
|
||||
expected := &UnmarshalError{Err: ErrUnmarshal, Content: content, ErrorText: err.Error()}
|
||||
assert.Equal(t, expected, actual)
|
||||
}
|
||||
|
||||
func TestUnmarshalError_WithErr(t *testing.T) {
|
||||
someError := errors.New("some error")
|
||||
otherError := errors.New("other error")
|
||||
actual := NewUnmarshalError(someError).WithErr(otherError)
|
||||
expected := &UnmarshalError{Err: otherError, ErrorText: someError.Error()}
|
||||
assert.Equal(t, expected, actual)
|
||||
}
|
||||
Loading…
Add table
Reference in a new issue