Module: Lucid::Shopify

Extended by:
Dry::Configurable
Defined in:
lib/lucid/shopify.rb,
lib/lucid/shopify/error.rb,
lib/lucid/shopify/types.rb,
lib/lucid/shopify/client.rb,
lib/lucid/shopify/request.rb,
lib/lucid/shopify/version.rb,
lib/lucid/shopify/webhook.rb,
lib/lucid/shopify/response.rb,
lib/lucid/shopify/authorise.rb,
lib/lucid/shopify/container.rb,
lib/lucid/shopify/credentials.rb,
lib/lucid/shopify/get_request.rb,
lib/lucid/shopify/put_request.rb,
lib/lucid/shopify/bulk_request.rb,
lib/lucid/shopify/post_request.rb,
lib/lucid/shopify/send_request.rb,
lib/lucid/shopify/webhook_list.rb,
lib/lucid/shopify/create_charge.rb,
lib/lucid/shopify/create_webhook.rb,
lib/lucid/shopify/delete_request.rb,
lib/lucid/shopify/delete_webhook.rb,
lib/lucid/shopify/verify_webhook.rb,
lib/lucid/shopify/activate_charge.rb,
lib/lucid/shopify/verify_callback.rb,
lib/lucid/shopify/parse_link_header.rb,
lib/lucid/shopify/throttled_strategy.rb,
lib/lucid/shopify/create_all_webhooks.rb,
lib/lucid/shopify/delete_all_webhooks.rb,
lib/lucid/shopify/graphql_post_request.rb,
lib/lucid/shopify/webhook_handler_list.rb,
lib/lucid/shopify/redis_throttled_strategy.rb

Defined Under Namespace

Modules: Types Classes: ActivateCharge, AuthenticatedClient, Authorise, BulkRequest, Client, CreateAllWebhooks, CreateCharge, CreateWebhook, Credentials, DeleteAllWebhooks, DeleteRequest, DeleteWebhook, GetRequest, GraphQLPostRequest, ParseLinkHeader, PostRequest, PutRequest, RedisThrottledStrategy, Request, Response, SendRequest, ThrottledStrategy, VerifyCallback, VerifyWebhook, Webhook, WebhookHandlerList, WebhookList

Constant Summary collapse

Error =

Subclass this class for all gem exceptions, so that callers may rescue any subclass with:

rescue Lucid::Shopify::Error => e
Class.new(StandardError)
VERSION =
'0.63.0'
Container =
Dry::Container.new

Class Method Summary collapse

Class Method Details

.assert_api_version!(version) ⇒ Object

Parameters:

  • version (String)

Raises:

  • (RuntimeError)


60
61
62
# File 'lib/lucid/shopify.rb', line 60

def assert_api_version!(version)
  raise "requires API version >= #{version}" if config.api_version < version
end

.handlersWebhookHandlerList

Handlers for webhook topics.

Examples:

Lucid::Shopify.handlers.register('orders/create', OrdersCreateWebhook.new)

Call topic handlers

webhook = Webhook.new(myshopify_domain, topic, data)

Lucid::Shopify.handlers.delegate(webhook)

Returns:



85
86
87
# File 'lib/lucid/shopify.rb', line 85

def handlers
  @handlers ||= WebhookHandlerList.new
end

.webhooksWebhookList

Webhooks created for each shop.

Examples:

Lucid::Shopify.webhooks.register('orders/create', fields: 'id,tags')

Returns:



70
71
72
# File 'lib/lucid/shopify.rb', line 70

def webhooks
  @webhooks ||= WebhookList.new
end