puffery

package module
v0.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 15, 2022 License: MIT Imports: 5 Imported by: 0

README

Go Puffery 🐡

Read and send push notifications to your iOS device from your command line with Puffery.

If you want to build an app on top of Puffery, you can also use github.com/vknabel/puffery-go as a library.

Puffery CLI showcase

In case you need inspiration or help, head over to our GitHub discussions!

Installation

The easiest way to install and update Puffery on macOS or linux is Homebrew.

brew install vknabel/install/puffery

Using Go

If you are a gopher and want to install it globally, just run:

go install github.com/vknabel/go-puffery@latest

In case you plan to write custom tooling on top of Puffery, start by adding to to your Go module.

go get github.com/vknabel/go-puffery@latest

Manual installation

If you are neither using Homebrew nor Go, head over to the GitHub releases page and pick the latest version that fits your operating system and architecture.

Unpack the archive and move it to a location of your choice, preferably into a directory in your $PATH.

Current Status

Currently go puffery is still in early development and doesn't yet support all features of the Puffery iOS App.

  • Logging in and out
  • Displaying all channels
  • Displaying all messages
  • Sending push notifications
  • Sending push notifications with colors
  • Creating and subscribing to channels
  • Displaying stats of a channel

Embedding puffery in your app

The main puffery module exports the whole API and all of its models. Start by creating a new Api

import (
    puffery "github.com/vknabel/go-puffery"
)

var pufferyApi = puffery.New()

err := pufferyApi.Hello()
if err != nil {
    panic(err)
}

Most endpoints require setting the token - either by confirming a login challenge (*Api) ConfirmLogin or by registering a new user (*Api) Register.

If you want to handle the session yourself, feel free to call (*Api) SetToken manually.

License

go-puffery is licensed under the MIT license.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Api 

type Api struct {
	Root string
	// contains filtered or unexported fields
}

func New 

func New() Api

func (Api) ChannelStats 

func (a Api) ChannelStats(id string) (SubscribedChannelDeletedResponse, error)

func (Api) Channels 

func (a Api) Channels() ([]Channel, error)

func (Api) ConfirmEmail 

func (a Api) ConfirmEmail(confirmationId string) (ConfirmedEmailResponse, error)

func (*Api) ConfirmLogin 

func (a *Api) ConfirmLogin(confirmationId string) (TokenResponse, error)

func (Api) CreateChannel 

func (a Api) CreateChannel(req CreateChannelRequest) (Channel, error)

func (Api) CreateDevice 

func (a Api) CreateDevice(req CreateDeviceRequest) (DeviceResponse, error)

func (Api) CreateMessage 

func (a Api) CreateMessage(channel Channel, req CreateMessageRequest) (Message, error)

func (Api) GetChannel 

func (a Api) GetChannel(id string) (Channel, error)

func (Api) Hello 

func (a Api) Hello() error

func (Api) LoggedIn 

func (a Api) LoggedIn() bool

func (Api) Login 

func (a Api) Login(email string) (LoginAttemptResponse, error)

func (*Api) Logout 

func (a *Api) Logout() error

func (Api) MessagesOfAllChannels 

func (a Api) MessagesOfAllChannels() ([]Message, error)

func (Api) MessagesOfChannel 

func (a Api) MessagesOfChannel(channel Channel) ([]Message, error)

func (Api) OwnChannels 

func (a Api) OwnChannels() ([]Channel, error)

func (Api) Profile 

func (a Api) Profile() (User, error)

func (Api) PublicNotify 

func (a Api) PublicNotify(notifyKey string, req CreateMessageRequest) (NotifyMessageResponse, error)

func (*Api) Register 

func (a *Api) Register(email string) (TokenResponse, error)

func (*Api) SetToken 

func (a *Api) SetToken(token string) error

func (Api) SharedChannels 

func (a Api) SharedChannels() ([]Channel, error)

func (Api) SubscribeToChannel 

func (a Api) SubscribeToChannel(req CreateSubscriptionRequest) (Channel, error)

func (Api) UnsubscribeChannel 

func (a Api) UnsubscribeChannel(id string) (SubscribedChannelDeletedResponse, error)

func (Api) UpdateChannel 

func (a Api) UpdateChannel(id string, req UpdateSubscriptionRequest) (Channel, error)

func (Api) UpdateDevice 

func (a Api) UpdateDevice(id string, req UpdateDeviceRequest) (DeviceResponse, error)

func (Api) UpdateProfile 

func (a Api) UpdateProfile(req UpdateProfileRequest) (User, error)

type Channel 

type Channel = SubscribedChannelResponse

type ConfirmedEmailResponse 

type ConfirmedEmailResponse struct{}

type CreateChannelRequest 

type CreateChannelRequest struct {
	Title    string `json:"title"`
	IsSilent bool   `json:"isSilent"`
}

type CreateDeviceRequest 

type CreateDeviceRequest struct {
	Token        string `json:"token"`
	IsProduction bool   `json:"isProduction"`
}

type CreateMessageRequest 

type CreateMessageRequest struct {
	Title string `json:"title"`
	Body  string `json:"body"`
	Color string `json:"color"`
}

type CreateSubscriptionRequest 

type CreateSubscriptionRequest struct {
	ReceiveOrNotifyKey string `json:"receiveOrNotifyKey"`
	IsSilent           bool   `json:"isSilent"`
}

type CreateUserRequest 

type CreateUserRequest struct {
	Email *string `json:"email"`
}

type DeviceResponse 

type DeviceResponse struct {
	ID           string `json:"id"`
	Token        string `json:"token"`
	IsProduction bool   `json:"isProduction"`
}

type LoginAttemptResponse 

type LoginAttemptResponse struct{}

type LoginUserRequest 

type LoginUserRequest struct {
	Email string `json:"email"`
}

type Message 

type Message = MessageResponse

type MessageResponse 

type MessageResponse struct {
	Body      string `json:"body"`
	CreatedAt string `json:"createdAt"`
	ColorName string `json:"colorName"`
	ID        string `json:"id"`
	Title     string `json:"title"`
	Channel   string `json:"channel"`
}

type NotifyMessageResponse 

type NotifyMessageResponse struct {
	Body      string `json:"body"`
	CreatedAt string `json:"createdAt"`
	Color     string `json:"color"`
	ID        string `json:"id"`
	Title     string `json:"title"`
}

type SubscribedChannelDeletedResponse 

type SubscribedChannelDeletedResponse struct{}

type SubscribedChannelResponse 

type SubscribedChannelResponse struct {
	Id             string  `json:"id"`
	Title          string  `json:"title"`
	IsSilent       bool    `json:"isSilent"`
	ReceiveOnlyKey string  `json:"receiveOnlyKey"`
	NotifyKey      *string `json:"notifyKey"`
}

type SubscribedChannelStatisticsResponse 

type SubscribedChannelStatisticsResponse struct {
	Notifiers int `json:"notifiers"`
	Receivers int `json:"receivers"`
	Messages  int `json:"messages"`
}

type TokenResponse 

type TokenResponse struct {
	Token string `json:"token"`
	User  User   `json:"user"`
}

type UpdateDeviceRequest 

type UpdateDeviceRequest struct {
	IsProduction bool `json:"isProduction"`
}

type UpdateProfileRequest 

type UpdateProfileRequest struct {
	Email string `json:"email"`
}

type UpdateSubscriptionRequest 

type UpdateSubscriptionRequest struct {
	IsSilent bool `json:"isSilent"`
}

type User 

type User = UserResponse

type UserResponse 

type UserResponse struct {
	ID          string `json:"id"`
	IsConfirmed bool   `json:"isConfirmed"`
	Email       string `json:"email"`
}

Source Files

View all Source files

Directories

Path Synopsis
cmd
puffery command
puffery/cmd

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.