Module: Spree

Defined in:
lib/spree/api/testing_support/v3/base.rb,
lib/spree/api.rb,
lib/spree/api/engine.rb,
lib/spree/api/dependencies.rb,
lib/spree/api/configuration.rb,
app/jobs/spree/webhook_delivery_job.rb,
lib/spree/api/openapi/schema_helper.rb,
app/jobs/spree/api_keys/mark_as_used.rb,
app/services/spree/webhooks/deliver_webhook.rb,
lib/spree/api/middleware/request_size_limit.rb,
app/controllers/spree/api/v3/base_controller.rb,
app/serializers/spree/api/v3/base_serializer.rb,
app/serializers/spree/api/v3/cart_serializer.rb,
app/services/spree/api/v3/filters_aggregator.rb,
app/serializers/spree/api/v3/asset_serializer.rb,
app/serializers/spree/api/v3/media_serializer.rb,
app/serializers/spree/api/v3/order_serializer.rb,
app/serializers/spree/api/v3/price_serializer.rb,
app/serializers/spree/api/v3/state_serializer.rb,
app/serializers/spree/api/v3/export_serializer.rb,
app/serializers/spree/api/v3/import_serializer.rb,
app/serializers/spree/api/v3/locale_serializer.rb,
app/serializers/spree/api/v3/market_serializer.rb,
app/serializers/spree/api/v3/policy_serializer.rb,
app/serializers/spree/api/v3/refund_serializer.rb,
app/serializers/spree/api/v3/report_serializer.rb,
app/subscribers/spree/webhook_event_subscriber.rb,
app/serializers/spree/api/v3/address_serializer.rb,
app/serializers/spree/api/v3/country_serializer.rb,
app/serializers/spree/api/v3/digital_serializer.rb,
app/serializers/spree/api/v3/payment_serializer.rb,
app/serializers/spree/api/v3/product_serializer.rb,
app/serializers/spree/api/v3/variant_serializer.rb,
app/controllers/concerns/spree/api/v3/idempotent.rb,
app/controllers/concerns/spree/api/v3/order_lock.rb,
app/controllers/spree/api/v3/resource_controller.rb,
app/serializers/spree/api/v3/category_serializer.rb,
app/serializers/spree/api/v3/currency_serializer.rb,
app/serializers/spree/api/v3/customer_serializer.rb,
app/serializers/spree/api/v3/discount_serializer.rb,
app/serializers/spree/api/v3/wishlist_serializer.rb,
app/serializers/spree/api/v3/gift_card_serializer.rb,
app/serializers/spree/api/v3/line_item_serializer.rb,
app/serializers/spree/api/v3/promotion_serializer.rb,
app/controllers/concerns/spree/api/v3/http_caching.rb,
app/controllers/spree/api/v3/admin/base_controller.rb,
app/controllers/spree/api/v3/store/auth_controller.rb,
app/controllers/spree/api/v3/store/base_controller.rb,
app/serializers/spree/api/v3/import_row_serializer.rb,
app/serializers/spree/api/v3/invitation_serializer.rb,
app/serializers/spree/api/v3/stock_item_serializer.rb,
app/controllers/concerns/spree/api/v3/error_handler.rb,
app/controllers/spree/api/v3/store/carts_controller.rb,
app/serializers/spree/api/v3/admin/asset_serializer.rb,
app/serializers/spree/api/v3/admin/media_serializer.rb,
app/serializers/spree/api/v3/admin/order_serializer.rb,
app/serializers/spree/api/v3/admin/price_serializer.rb,
app/serializers/spree/api/v3/admin/state_serializer.rb,
app/serializers/spree/api/v3/credit_card_serializer.rb,
app/serializers/spree/api/v3/fulfillment_serializer.rb,
app/serializers/spree/api/v3/option_type_serializer.rb,
app/serializers/spree/api/v3/return_item_serializer.rb,
app/controllers/spree/api/v3/store/orders_controller.rb,
app/serializers/spree/api/v3/admin/market_serializer.rb,
app/serializers/spree/api/v3/admin/refund_serializer.rb,
app/serializers/spree/api/v3/custom_field_serializer.rb,
app/serializers/spree/api/v3/digital_link_serializer.rb,
app/serializers/spree/api/v3/option_value_serializer.rb,
app/serializers/spree/api/v3/store_credit_serializer.rb,
app/serializers/spree/api/v3/tax_category_serializer.rb,
app/controllers/concerns/spree/api/v3/cart_resolvable.rb,
app/controllers/spree/api/v3/store/locales_controller.rb,
app/controllers/spree/api/v3/store/markets_controller.rb,
app/serializers/spree/api/v3/admin/address_serializer.rb,
app/serializers/spree/api/v3/admin/country_serializer.rb,
app/serializers/spree/api/v3/admin/payment_serializer.rb,
app/serializers/spree/api/v3/admin/product_serializer.rb,
app/serializers/spree/api/v3/admin/variant_serializer.rb,
app/serializers/spree/api/v3/delivery_rate_serializer.rb,
app/serializers/spree/api/v3/price_history_serializer.rb,
app/serializers/spree/api/v3/reimbursement_serializer.rb,
app/serializers/spree/api/v3/wishlist_item_serializer.rb,
app/controllers/concerns/spree/api/v3/security_headers.rb,
app/controllers/spree/api/v3/admin/resource_controller.rb,
app/controllers/spree/api/v3/store/digitals_controller.rb,
app/controllers/spree/api/v3/store/policies_controller.rb,
app/controllers/spree/api/v3/store/products_controller.rb,
app/controllers/spree/api/v3/store/resource_controller.rb,
app/serializers/spree/api/v3/admin/category_serializer.rb,
app/serializers/spree/api/v3/admin/customer_serializer.rb,
app/serializers/spree/api/v3/admin/discount_serializer.rb,
app/serializers/spree/api/v3/payment_method_serializer.rb,
app/serializers/spree/api/v3/payment_source_serializer.rb,
app/serializers/spree/api/v3/stock_location_serializer.rb,
app/serializers/spree/api/v3/stock_movement_serializer.rb,
app/serializers/spree/api/v3/stock_transfer_serializer.rb,
app/controllers/spree/api/v3/store/countries_controller.rb,
app/controllers/spree/api/v3/store/customers_controller.rb,
app/controllers/spree/api/v3/store/wishlists_controller.rb,
app/serializers/spree/api/v3/admin/gift_card_serializer.rb,
app/serializers/spree/api/v3/admin/line_item_serializer.rb,
app/serializers/spree/api/v3/customer_return_serializer.rb,
app/serializers/spree/api/v3/delivery_method_serializer.rb,
app/serializers/spree/api/v3/gift_card_batch_serializer.rb,
app/serializers/spree/api/v3/payment_session_serializer.rb,
app/controllers/concerns/spree/api/v3/jwt_authentication.rb,
app/controllers/concerns/spree/api/v3/rate_limit_headers.rb,
app/controllers/spree/api/v3/store/categories_controller.rb,
app/controllers/spree/api/v3/store/currencies_controller.rb,
app/controllers/spree/api/v3/store/data_feeds_controller.rb,
app/serializers/spree/api/v3/admin/adjustment_serializer.rb,
app/serializers/spree/api/v3/admin/admin_user_serializer.rb,
app/serializers/spree/api/v3/admin/stock_item_serializer.rb,
app/controllers/concerns/spree/api/v3/locale_and_currency.rb,
app/controllers/concerns/spree/api/v3/resource_serializer.rb,
app/controllers/spree/api/v3/store/carts/items_controller.rb,
app/controllers/spree/api/v3/webhooks/payments_controller.rb,
app/serializers/spree/api/v3/admin/credit_card_serializer.rb,
app/serializers/spree/api/v3/admin/fulfillment_serializer.rb,
app/serializers/spree/api/v3/admin/option_type_serializer.rb,
app/serializers/spree/api/v3/shipping_category_serializer.rb,
app/serializers/spree/api/v3/admin/custom_field_serializer.rb,
app/serializers/spree/api/v3/admin/digital_link_serializer.rb,
app/serializers/spree/api/v3/admin/option_value_serializer.rb,
app/serializers/spree/api/v3/admin/store_credit_serializer.rb,
app/serializers/spree/api/v3/admin/tax_category_serializer.rb,
app/serializers/spree/api/v3/admin/delivery_rate_serializer.rb,
app/serializers/spree/api/v3/admin/price_history_serializer.rb,
app/serializers/spree/api/v3/admin/reimbursement_serializer.rb,
app/controllers/concerns/spree/api/v3/api_key_authentication.rb,
app/controllers/spree/api/v3/store/carts/payments_controller.rb,
app/controllers/spree/api/v3/store/wishlist_items_controller.rb,
app/serializers/spree/api/v3/admin/allowed_origin_serializer.rb,
app/serializers/spree/api/v3/admin/payment_method_serializer.rb,
app/serializers/spree/api/v3/admin/payment_source_serializer.rb,
app/serializers/spree/api/v3/admin/stock_location_serializer.rb,
app/serializers/spree/api/v3/return_authorization_serializer.rb,
app/controllers/spree/api/v3/store/customer/orders_controller.rb,
app/serializers/spree/api/v3/admin/delivery_method_serializer.rb,
app/serializers/spree/api/v3/newsletter_subscriber_serializer.rb,
app/serializers/spree/api/v3/payment_setup_session_serializer.rb,
app/controllers/spree/api/v3/store/carts/gift_cards_controller.rb,
app/controllers/spree/api/v3/store/products/filters_controller.rb,
app/controllers/spree/api/v3/store/markets/countries_controller.rb,
app/serializers/spree/api/v3/admin/shipping_category_serializer.rb,
app/controllers/spree/api/v3/store/carts/fulfillments_controller.rb,
app/controllers/spree/api/v3/store/customer/addresses_controller.rb,
app/controllers/spree/api/v3/store/carts/store_credits_controller.rb,
app/controllers/spree/api/v3/store/customer/gift_cards_controller.rb,
app/controllers/spree/api/v3/store/carts/discount_codes_controller.rb,
app/serializers/spree/api/v3/admin/return_authorization_serializer.rb,
app/controllers/concerns/spree/api/v3/store/search_provider_support.rb,
app/controllers/spree/api/v3/store/customer/credit_cards_controller.rb,
app/controllers/spree/api/v3/store/carts/payment_sessions_controller.rb,
app/controllers/spree/api/v3/store/customer/store_credits_controller.rb,
app/controllers/spree/api/v3/store/customer/password_resets_controller.rb,
app/controllers/spree/api/v3/store/customer/payment_setup_sessions_controller.rb

Overview

Helper module for generating JWT tokens in tests

Defined Under Namespace

Modules: Api, ApiKeys, Webhooks Classes: ApiDependenciesAccessor, WebhookDeliveryJob, WebhookEventSubscriber

Class Method Summary collapse

Class Method Details

.api ⇒ Spree::ApiDependenciesAccessor

API dependencies accessor for cleaner access to API dependencies

Examples:

Getting a dependency (returns resolved class)

Spree.api.storefront_coupon_handler.call(order: order, coupon_code: code)

Setting a dependency

Spree.api.storefront_coupon_handler = MyApp::CouponHandler

Returns:



20
21
22
 
# File 'lib/spree/api.rb', line 20

def self.api
  @api_accessor ||= ApiDependenciesAccessor.new
end