goth: Index | Files

package shopify

import ""

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 Goth.


Package Files

scopes.go session.go shopify.go


const (
    ScopeReadContent                 = "read_content"
    ScopeWriteContent                = "write_content"
    ScopeReadThemes                  = "read_themes"
    ScopeWriteThemes                 = "write_themes"
    ScopeReadProducts                = "read_products"
    ScopeWriteProducts               = "write_products"
    ScopeReadProductListings         = "read_product_listings"
    ScopeReadCustomers               = "read_customers"
    ScopeWriteCustomers              = "write_customers"
    ScopeReadOrders                  = "read_orders"
    ScopeWriteOrders                 = "write_orders"
    ScopeReadDrafOrders              = "read_draft_orders"
    ScopeWriteDrafOrders             = "write_draft_orders"
    ScopeReadInventory               = "read_inventory"
    ScopeWriteInventory              = "write_inventory"
    ScopeReadLocations               = "read_locations"
    ScopeReadScriptTags              = "read_script_tags"
    ScopeWriteScriptTags             = "write_script_tags"
    ScopeReadFulfillments            = "read_fulfillments"
    ScopeWriteFulfillments           = "write_fulfillments"
    ScopeReadShipping                = "read_shipping"
    ScopeWriteShipping               = "write_shipping"
    ScopeReadAnalytics               = "read_analytics"
    ScopeReadUsers                   = "read_users"
    ScopeWriteUsers                  = "write_users"
    ScopeReadCheckouts               = "read_checkouts"
    ScopeWriteCheckouts              = "write_checkouts"
    ScopeReadReports                 = "read_reports"
    ScopeWriteReports                = "write_reports"
    ScopeReadPriceRules              = "read_price_rules"
    ScopeWritePriceRules             = "write_price_rules"
    ScopeMarketingEvents             = "read_marketing_events"
    ScopeWriteMarketingEvents        = "write_marketing_events"
    ScopeReadResourceFeedbacks       = "read_resource_feedbacks"
    ScopeWriteResourceFeedbacks      = "write_resource_feedbacks"
    ScopeReadShopifyPaymentsPayouts  = "read_shopify_payments_payouts"
    ScopeReadShopifyPaymentsDisputes = "read_shopify_payments_disputes"

    // Special:
    // Grants access to all orders rather than the default window of 60 days worth of orders.
    // This OAuth scope is used in conjunction with read_orders, or write_orders. You need to request
    // this scope from your Partner Dashboard before adding it to your app.
    ScopeReadAllOrders = "read_all_orders"

Define scopes supported by Shopify. See:

type Provider Uses

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

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

func New Uses

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

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

func (*Provider) BeginAuth Uses

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

BeginAuth asks Shopify for an authentication end-point.

func (*Provider) Client Uses

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

Client is HTTP client to be used in all fetch operations.

func (*Provider) Debug Uses

func (p *Provider) Debug(debug bool)

Debug is a no-op for the Shopify package.

func (*Provider) FetchUser Uses

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

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

func (*Provider) Name Uses

func (p *Provider) Name() string

Name is the name used to retrieve this provider later.

func (*Provider) RefreshToken Uses

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

RefreshToken get new access token based on the refresh token

func (*Provider) RefreshTokenAvailable Uses

func (p *Provider) RefreshTokenAvailable() bool

RefreshTokenAvailable refresh token is provided by auth provider or not

func (*Provider) SetName Uses

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) SetShopName Uses

func (p *Provider) SetShopName(name string)

SetShopName is to update the shopify shop name, needed when interfacing with different shops.

func (*Provider) UnmarshalSession Uses

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

UnmarshalSession wil unmarshal a JSON string into a session.

type Session Uses

type Session struct {
    AuthURL     string
    AccessToken string
    Hostname    string
    HMAC        string
    ExpiresAt   time.Time

Session stores data during the auth process with Shopify.

func (*Session) Authorize Uses

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

Authorize the session with Shopify and return the access token to be stored for future use.

func (Session) GetAuthURL Uses

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

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

func (Session) Marshal Uses

func (s Session) Marshal() string

Marshal the session into a string

func (Session) String Uses

func (s Session) String() string

Package shopify imports 15 packages (graph) and is imported by 3 packages. Updated 2019-06-19. Refresh now. Tools for package owners.