Struct ShopifyPlugin 

pub struct ShopifyPlugin { /* private fields */ }

Shopify as an Autumn plugin.

Implementations

impl ShopifyPlugin

pub fn new() -> Self

Make the plugin.

pub fn configure( self, configure: impl Fn(&mut ShopifyConfig) + Send + Sync + 'static, ) -> Self

Change config values in code. The closure runs after the file and the environment, so its values win. It cannot set secrets.

pub fn webhook( self, topic: impl Into<String>, handler: impl IntoWebhookHandler, ) -> Self

Handle webhooks for topic, for example orders/create.

A malformed or repeated topic stops the startup.

pub fn token_store(self, store: Arc<dyn TokenStore>) -> Self

Replace the in-memory token store.

pub fn delivery_store(self, store: Arc<dyn DeliveryStore>) -> Self

Replace the in-memory duplicate-delivery store.

pub fn on_install<F, Fut>(self, handler: F) -> Self

where F: Fn(InstallContext) -> Fut + Send + Sync + 'static, Fut: Future<Output = AutumnResult<()>> + Send + 'static,

Run handler after each install, when the token is stored. Use it to save a shop record or to subscribe webhooks. An error gives 500. The token stays in the store.

pub fn admin_base_url(self, base_url: impl Into<String>) -> Self

Send Admin API and OAuth calls to base_url instead of https://{shop}. For tests only: the startup fails unless the host is localhost, 127.0.0.1, or [::1], because the calls carry the client secret and the tokens.

pub fn build_runtime(&self, config: ShopifyConfig) -> Result<ShopifyRuntime>

Build the runtime from a loaded config: apply the builder closures, validate, and register the webhook handlers.

The startup hook calls this with ShopifyConfig::load. Tests call it with ShopifyConfig::from_sources.

Errors

Returns Error::Config when the config is not valid or a webhook topic is malformed or repeated.

Trait Implementations

impl Clone for ShopifyPlugin

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ShopifyPlugin

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ShopifyPlugin

fn default() -> Self

Returns the “default value” for a type.

impl Plugin for ShopifyPlugin

fn contract(&self) -> Option<PluginContract>

Declare the supported autumn-web range. A mismatch fails at registration with both versions named.

fn name(&self) -> Cow<'static, str>

Stable identifier used for duplicate-registration detection.

fn build(self, app: AppBuilder) -> AppBuilder

Apply this plugin’s configuration to the builder.

fn route_group(&self) -> Cow<'static, str>

The route group of the routes this plugin adds (#3544).