proofofphonenumberverification

Documentation

Index

• Variables
• type Hook
• type HookHTTPClient
  • func NewHookHTTPClient(cfg *config.ProofOfPhoneNumberVerificationHookConfig) HookHTTPClient
• type HookRequest
• type HookResponse
  • func ParseHookResponse(ctx context.Context, r io.Reader) (*HookResponse, error)
• type ProofOfPhoneNumberVerificationWebHook
  • func (h *ProofOfPhoneNumberVerificationWebHook) Call(ctx context.Context, u *url.URL, hookReq *HookRequest) (*HookResponse, error)
• type Service
  • func (s *Service) Verify(ctx context.Context, proofOfPhoneNumberVerificationString string) (*HookResponse, error)
• type WebhookMiddlewareLogger
  • func NewWebhookMiddlewareLogger(lf *log.Factory) WebhookMiddlewareLogger

Variables

var DependencySet = wire.NewSet(
	NewHookHTTPClient,
	wire.Struct(new(Service), "*"),
	wire.Struct(new(ProofOfPhoneNumberVerificationWebHook), "*"),
	NewWebhookMiddlewareLogger,
)

var HookResponseSchema = validation.NewSimpleSchema(`
{
	"type": "object",
	"additionalProperties": false,
	"properties": {
		"identity": {
			"type": "object",
			"additionalProperties": false,
			"properties": {
				"type" : {
					"type": "string",
					"enum" : ["login_id"]
				},
				"login_id": {
					"type": "object",
					"properties": {
						"key": { "type": "string" },
						"type": { "type": "string" },
						"value": { "type": "string" }
					},
					"required": ["key", "type", "value"]
				}
			}
		}
	},
	"required": ["identity"]
}
`)

var InvalidConfiguration = apierrors.InternalError.WithReason("InvalidConfiguration")

Types

type Hook

type Hook interface {
	Call(ctx context.Context, u *url.URL, hookReq *HookRequest) (*HookResponse, error)
}

type HookHTTPClient

type HookHTTPClient struct {
	*http.Client
}

func NewHookHTTPClient

func NewHookHTTPClient(cfg *config.ProofOfPhoneNumberVerificationHookConfig) HookHTTPClient

type HookRequest

type HookRequest struct {
	ProofOfPhoneNumberVerification string `json:"proof_of_phone_number_verification"`
}

type HookResponse

type HookResponse struct {
	Identity *identity.Spec `json:"identity"`
}

func ParseHookResponse

func ParseHookResponse(ctx context.Context, r io.Reader) (*HookResponse, error)

type ProofOfPhoneNumberVerificationWebHook

type ProofOfPhoneNumberVerificationWebHook struct {
	hook.WebHook
	Client HookHTTPClient
	Logger WebhookMiddlewareLogger
}

func (*ProofOfPhoneNumberVerificationWebHook) Call

func (h *ProofOfPhoneNumberVerificationWebHook) Call(ctx context.Context, u *url.URL, hookReq *HookRequest) (*HookResponse, error)

type Service

type Service struct {
	Config  *config.ProofOfPhoneNumberVerificationHookConfig
	WebHook *ProofOfPhoneNumberVerificationWebHook
}

func (*Service) Verify

func (s *Service) Verify(ctx context.Context, proofOfPhoneNumberVerificationString string) (*HookResponse, error)

type WebhookMiddlewareLogger

type WebhookMiddlewareLogger struct{ *log.Logger }

func NewWebhookMiddlewareLogger

func NewWebhookMiddlewareLogger(lf *log.Factory) WebhookMiddlewareLogger