spree_api 5.3.0.rc2 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bbb546eb54b2cff0a413d9989bbeb324c6b7b8db6bf5cd323b297a6e23fe0cc
-  data.tar.gz: a36baaff83201059e4c4b96b3d97e73c7e6eb8e94644fdc74c67320c4eed9eee
+  metadata.gz: 759a825eaed204d12c89d99b5ea72e458d3798c9afe452bf61e438492fc3d8b6
+  data.tar.gz: 98f44fdc93e9c4cad74c52ccb58b2b82d62064c53dc9f7fa9d963ca78ed37b41
 SHA512:
-  metadata.gz: 2b62449e706304aa30971e2eb1dadda2429d3308e34cd98aafe1029a31842c2e6bdf9684dd216e0182309d2c6d6cb0d42e25f114794ff36af86574ceb1fc063e
-  data.tar.gz: 1894f064a469b4afd3952f04728972486bdac54090e2b0100bb31e6e5a9ce0313a31142499cc1c4fd2a17079fe7ad17d93e37d7bff1f7702fd2675d31ab0896e
+  metadata.gz: 7f72604d32947620decb96ee56abe7009d460c04ea8ff1646ab0b0bcd2713ac18e5f589ad05f99e0dc9d11d1ce1acc78bc0fcf3a54bbaaede17959b2bb7c1181
+  data.tar.gz: 5d8809fcfe387e374449bb285df5c10df363a2e972e8b3c0fba5c2d7644841e437e70b166bd981765801390c706361bdcb2423c2922a0c7e588735a5d9adf2f9

data/README.md

@@ -0,0 +1,99 @@
+# Spree API
+
+[![Gem Version](https://badge.fury.io/rb/spree_api.svg)](https://badge.fury.io/rb/spree_api)
+
+Spree API provides RESTful API endpoints for building custom storefronts, mobile applications, and third-party integrations with Spree Commerce.
+
+## Overview
+
+This gem includes:
+
+- **Storefront API** - Customer-facing endpoints for cart, checkout, products, and accounts
+- **Platform API** - Administrative endpoints for managing orders, products, and store settings
+- **Webhooks** - Event-driven notifications to external systems
+- **OAuth2 Authentication** - Token-based authentication via Doorkeeper
+- **JSONAPI Serializers** - Standardized API responses
+
+## Installation
+
+This gem is included in every Spree installation. No additional steps are required.
+
+## API Endpoints
+
+### Storefront API (v2)
+
+The Storefront API is designed for building custom frontends:
+
+```
+GET    /api/v2/storefront/products
+GET    /api/v2/storefront/products/:id
+GET    /api/v2/storefront/taxons
+POST   /api/v2/storefront/cart
+PATCH  /api/v2/storefront/cart/add_item
+PATCH  /api/v2/storefront/checkout
+POST   /api/v2/storefront/account
+```
+
+### Platform API
+
+The Platform API provides administrative access:
+
+```
+GET    /api/v2/platform/orders
+POST   /api/v2/platform/products
+PATCH  /api/v2/platform/variants/:id
+DELETE /api/v2/platform/line_items/:id
+```
+
+## Authentication
+
+### OAuth2 Token Authentication
+
+```bash
+# Request access token
+curl -X POST https://your-store.com/spree_oauth/token \
+  -d "grant_type=password&username=user@example.com&password=secret"
+
+# Use token in requests
+curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
+  https://your-store.com/api/v2/storefront/account
+```
+
+### Guest Cart Token
+
+For guest checkout, use the `X-Spree-Order-Token` header:
+
+```bash
+curl -H "X-Spree-Order-Token: ORDER_TOKEN" \
+  https://your-store.com/api/v2/storefront/cart
+```
+
+## Serializers
+
+API responses use JSONAPI format. Customize serializers by creating your own:
+
+```ruby
+# app/serializers/my_app/product_serializer.rb
+module MyApp
+  class ProductSerializer < Spree::V2::Storefront::ProductSerializer
+    attribute :custom_field
+  end
+end
+
+# Configure in initializer
+Spree.api.storefront_product_serializer = 'MyApp::ProductSerializer'
+```
+
+## Testing
+
+```bash
+cd api
+bundle exec rake test_app  # First time only
+bundle exec rspec
+```
+
+## Documentation
+
+- [Storefront API Reference](https://docs.spreecommerce.org/api/storefront)
+- [Platform API Reference](https://docs.spreecommerce.org/api/platform)
+- [Authentication Guide](https://docs.spreecommerce.org/developer/api/authentication)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree_api
 version: !ruby/object:Gem::Version
-  version: 5.3.0.rc2
+  version: 5.3.0
 platform: ruby
 authors:
 - Ryan Bigg
@@ -115,14 +115,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.3.0.rc2
+        version: 5.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.3.0.rc2
+        version: 5.3.0
 description: Spree's API
 email:
 - hello@spreecommerce.org
@@ -131,6 +131,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE.md
+- README.md
 - Rakefile
 - app/controllers/concerns/spree/api/v2/caching.rb
 - app/controllers/concerns/spree/api/v2/coupon_codes_helper.rb
@@ -203,7 +204,6 @@ files:
 - app/helpers/spree/api/v2/collection_options_helpers.rb
 - app/helpers/spree/api/v2/display_money_helper.rb
 - app/helpers/spree/api/v2/store_media_serializer_images_concern.rb
-- app/jobs/spree/products/queue_status_changed_webhook_job.rb
 - app/jobs/spree/webhook_delivery_job.rb
 - app/models/concerns/spree/user_api_authentication.rb
 - app/models/concerns/spree/user_api_methods.rb
@@ -330,7 +330,6 @@ files:
 - app/serializers/spree/v2/storefront/variant_serializer.rb
 - app/serializers/spree/v2/storefront/wished_item_serializer.rb
 - app/serializers/spree/v2/storefront/wishlist_serializer.rb
-- app/services/spree/products/queue_status_changed_webhook.rb
 - app/services/spree/webhooks/deliver_webhook.rb
 - app/subscribers/spree/webhook_event_subscriber.rb
 - config/brakeman.ignore
@@ -369,9 +368,9 @@ licenses:
 - BSD-3-Clause
 metadata:
   bug_tracker_uri: https://github.com/spree/spree/issues
-  changelog_uri: https://github.com/spree/spree/releases/tag/v5.3.0.rc2
+  changelog_uri: https://github.com/spree/spree/releases/tag/v5.3.0
   documentation_uri: https://docs.spreecommerce.org/
-  source_code_uri: https://github.com/spree/spree/tree/v5.3.0.rc2
+  source_code_uri: https://github.com/spree/spree/tree/v5.3.0
 rdoc_options: []
 require_paths:
 - lib

data/app/jobs/spree/products/queue_status_changed_webhook_job.rb

@@ -1,12 +0,0 @@
-module Spree
-  module Products
-    class QueueStatusChangedWebhookJob < Spree::BaseJob
-      queue_as Spree.queues.webhooks
-
-      def perform(product_id, event)
-        product = Spree::Product.find(product_id)
-        product.queue_webhooks_requests!("product.#{event}")
-      end
-    end
-  end
-end

data/app/services/spree/products/queue_status_changed_webhook.rb

@@ -1,17 +0,0 @@
-module Spree
-  module Products
-    class QueueStatusChangedWebhook
-      def self.call(ids:, event:)
-        return false if ids.blank? || event.blank?
-
-        # for ActiveJob 7.1+
-        if ActiveJob.respond_to?(:perform_all_later)
-          jobs = ids.map { |id| Spree::Products::QueueStatusChangedWebhookJob.new(id, event) }
-          ActiveJob.perform_all_later(jobs)
-        else
-          ids.each { |id| Spree::Products::QueueStatusChangedWebhookJob.perform_later(id, event) }
-        end
-      end
-    end
-  end
-end