shopify

Documentation

Overview

Package shopify implements the OAuth2 protocol for authenticating users through shopify. This package can be used as a reference implementation of an OAuth2 provider for shopify.

Index

• Constants
• type Provider
  • func New(clientKey string, secret string, callbackURL string, shopName string, ...) *Provider
  • func (p *Provider) BeginAuth(state string) (goth.Session, error)
  • func (p *Provider) Client() *http.Client
  • func (p *Provider) Debug(debug bool)
  • func (p *Provider) FetchUser(session goth.Session) (goth.User, error)
  • func (p *Provider) Name() string
  • func (p *Provider) RefreshToken(refreshToken string) (*oauth2.Token, error)
  • func (p *Provider) RefreshTokenAvailable() bool
  • func (p *Provider) SetName(name string)
  • func (p *Provider) UnmarshalSession(data string) (goth.Session, error)
• type Session
  • func (s *Session) Authorize(provider goth.Provider, params goth.Params) (string, error)
  • func (s Session) GetAuthURL() (string, error)
  • func (s Session) Marshal() string
  • func (s Session) String() string

Constants

const (
	// ScopeProductsRead Access to Product, Product Variant, Product Image, Collect, Custom Collection, and Smart Collection.
	ScopeProductsRead string = "read_products"
	// ScopeOrdersRead Access to Order, Transaction and Fulfillment.
	ScopeOrdersRead string = "read_orders"
	// ScopeInventoryRead Access to Inventory Level and Inventory Item.
	ScopeInventoryRead string = "read_inventory"
	// ScopeLocationsRead Access to Inventory Level and Inventory Item.
	ScopeLocationsRead string = "read_locations"
)

Types

type Provider

type Provider struct {
	ClientKey   string
	Secret      string
	ShopName    string
	CallbackURL string
	HTTPClient  *http.Client
	// contains filtered or unexported fields
}

Provider is the implementation of `goth.Provider` for accessing shopify

func New

func New(clientKey string, secret string, callbackURL string, shopName string, scopes ...string) *Provider

New creates a new Shopify provider, and sets up important connection details, such as shop name You should always call `shopify.New` to get a new Provider. Never try to create one manually.

func (*Provider) BeginAuth

func (p *Provider) BeginAuth(state string) (goth.Session, error)

BeginAuth asks Shopify for an authentication end-point.

func (*Provider) Client

func (p *Provider) Client() *http.Client

Client returns the underlying http client

func (*Provider) Debug

func (p *Provider) Debug(debug bool)

Debug is no-op for the Shopify package.

func (*Provider) FetchUser

func (p *Provider) FetchUser(session goth.Session) (goth.User, error)

FetchUser will go to Shopify and access basic info about the user.

func (*Provider) Name

func (p *Provider) Name() string

Name gets the name used to retrieve this provider.

func (*Provider) RefreshToken

func (p *Provider) RefreshToken(refreshToken string) (*oauth2.Token, error)

RefreshToken get new access token based on the refresh token

func (*Provider) RefreshTokenAvailable

func (p *Provider) RefreshTokenAvailable() bool

RefreshTokenAvailable refresh token is provided by auth provider or not

func (*Provider) SetName

func (p *Provider) SetName(name string)

SetName is to update the name of the provider (needed in case of multiple providers of 1 type)

func (*Provider) UnmarshalSession

func (p *Provider) UnmarshalSession(data string) (goth.Session, error)

UnmarshalSession will unmarshal a JSON string into a session.

type Session

type Session struct {
	AuthURL      string
	AccessToken  string
	RefreshToken string
	ExpiresAt    time.Time
}

Session stores data during the auth process with Shopify

func (*Session) Authorize

func (s *Session) Authorize(provider goth.Provider, params goth.Params) (string, error)

Authorize completes the authorization with Shopify and returns the access token to be stored for future use.

func (Session) GetAuthURL

func (s Session) GetAuthURL() (string, error)

GetAuthURL will return the URL set by calling the `BeginAuth` function on the Shopify provider.

func (Session) Marshal

func (s Session) Marshal() string

Marshal marshals a session into a JSON string.

func (Session) String

func (s Session) String() string

String is equivalent to Marshal. It returns a JSON representation of the of the session.