spree_api 4.1.8 → 4.1.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/app/controllers/spree/api/v2/base_controller.rb +6 -1
- data/app/controllers/spree/api/v2/storefront/account/addresses_controller.rb +77 -0
- data/app/controllers/spree/api/v2/storefront/account/orders_controller.rb +2 -2
- data/app/controllers/spree/api/v2/storefront/checkout_controller.rb +1 -2
- data/app/controllers/spree/api/v2/storefront/order_status_controller.rb +1 -1
- data/app/controllers/spree/api/v2/storefront/stores_controller.rb +27 -0
- data/app/models/spree/api_dependencies.rb +11 -1
- data/app/serializers/spree/v2/storefront/cart_serializer.rb +3 -1
- data/app/serializers/spree/v2/storefront/line_item_serializer.rb +2 -1
- data/app/serializers/spree/v2/storefront/payment_serializer.rb +1 -1
- data/app/serializers/spree/v2/storefront/shipment_serializer.rb +3 -1
- data/app/serializers/spree/v2/storefront/stock_location_serializer.rb +11 -0
- data/app/serializers/spree/v2/storefront/store_credit_category_serializer.rb +11 -0
- data/app/serializers/spree/v2/storefront/store_credit_serializer.rb +1 -1
- data/app/serializers/spree/v2/storefront/store_serializer.rb +13 -0
- data/config/routes.rb +2 -0
- data/docs/v2/storefront/index.yaml +26 -0
- data/lib/spree/api/testing_support/v2/base.rb +1 -1
- data/lib/spree/api/testing_support/v2/current_order.rb +6 -0
- metadata +11 -6
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0e97b8e826fb8c422cac7fd8f2c48ed976bd801d2cd6b6a83d2bc63e7502680f
|
4
|
+
data.tar.gz: 590a06b109db49907897f093deefddeba7a1c9179a899507a4afb6634ce1351d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e38f559497fd36c7bd4660352ad2761002a07d441eaacce603eb4c9ae11a27ae5241715ff071dee71acd487f8c8368ca61ce301660b0b052bdd0d1379400d56e
|
7
|
+
data.tar.gz: c441f94c2e98c93b06dd0afefbf1fb9cd0aa5b27fa1057182bd135f8bd3c6dfe5325c54e0504aa44c75ee39015fb67261f43b74b4acdeea5bf765adcacf1dd68
|
@@ -53,7 +53,12 @@ module Spree
|
|
53
53
|
end
|
54
54
|
|
55
55
|
def spree_current_user
|
56
|
-
|
56
|
+
return nil unless doorkeeper_token
|
57
|
+
return @spree_current_user if @spree_current_user
|
58
|
+
|
59
|
+
doorkeeper_authorize!
|
60
|
+
|
61
|
+
@spree_current_user ||= Spree.user_class.find_by(id: doorkeeper_token.resource_owner_id)
|
57
62
|
end
|
58
63
|
|
59
64
|
def spree_authorize!(action, subject, *args)
|
@@ -0,0 +1,77 @@
|
|
1
|
+
module Spree
|
2
|
+
module Api
|
3
|
+
module V2
|
4
|
+
module Storefront
|
5
|
+
module Account
|
6
|
+
class AddressesController < ::Spree::Api::V2::BaseController
|
7
|
+
before_action :require_spree_current_user
|
8
|
+
|
9
|
+
def index
|
10
|
+
render_serialized_payload { serialize_collection(collection) }
|
11
|
+
end
|
12
|
+
|
13
|
+
def create
|
14
|
+
result = create_service.call(user: spree_current_user, address_params: address_params)
|
15
|
+
render_result(result)
|
16
|
+
end
|
17
|
+
|
18
|
+
def update
|
19
|
+
result = update_service.call(address: resource, address_params: address_params)
|
20
|
+
render_result(result)
|
21
|
+
end
|
22
|
+
|
23
|
+
private
|
24
|
+
|
25
|
+
def collection
|
26
|
+
collection_finder.new(scope: scope, params: params).execute
|
27
|
+
end
|
28
|
+
|
29
|
+
def resource
|
30
|
+
@resource ||= scope.find(params[:id])
|
31
|
+
end
|
32
|
+
|
33
|
+
def scope
|
34
|
+
spree_current_user.addresses
|
35
|
+
end
|
36
|
+
|
37
|
+
def collection_finder
|
38
|
+
Spree::Api::Dependencies.storefront_address_finder.constantize
|
39
|
+
end
|
40
|
+
|
41
|
+
def collection_serializer
|
42
|
+
Spree::Api::Dependencies.storefront_address_serializer.constantize
|
43
|
+
end
|
44
|
+
|
45
|
+
def resource_serializer
|
46
|
+
Spree::Api::Dependencies.storefront_address_serializer.constantize
|
47
|
+
end
|
48
|
+
|
49
|
+
def serialize_collection(collection)
|
50
|
+
collection_serializer.new(collection).serializable_hash
|
51
|
+
end
|
52
|
+
|
53
|
+
def create_service
|
54
|
+
Spree::Api::Dependencies.storefront_account_create_address_service.constantize
|
55
|
+
end
|
56
|
+
|
57
|
+
def update_service
|
58
|
+
Spree::Api::Dependencies.storefront_account_update_address_service.constantize
|
59
|
+
end
|
60
|
+
|
61
|
+
def address_params
|
62
|
+
params.require(:address).permit(permitted_address_attributes)
|
63
|
+
end
|
64
|
+
|
65
|
+
def render_result(result)
|
66
|
+
if result.success?
|
67
|
+
render_serialized_payload { serialize_resource(result.value) }
|
68
|
+
else
|
69
|
+
render_error_payload(result.error)
|
70
|
+
end
|
71
|
+
end
|
72
|
+
end
|
73
|
+
end
|
74
|
+
end
|
75
|
+
end
|
76
|
+
end
|
77
|
+
end
|
@@ -35,11 +35,11 @@ module Spree
|
|
35
35
|
end
|
36
36
|
|
37
37
|
def collection_serializer
|
38
|
-
Spree::Api::Dependencies.
|
38
|
+
Spree::Api::Dependencies.storefront_order_serializer.constantize
|
39
39
|
end
|
40
40
|
|
41
41
|
def resource_serializer
|
42
|
-
Spree::Api::Dependencies.
|
42
|
+
Spree::Api::Dependencies.storefront_order_serializer.constantize
|
43
43
|
end
|
44
44
|
|
45
45
|
def collection_finder
|
@@ -125,8 +125,7 @@ module Spree
|
|
125
125
|
def serialize_shipping_rates(shipments)
|
126
126
|
shipping_rates_serializer.new(
|
127
127
|
shipments,
|
128
|
-
include: [:shipping_rates]
|
129
|
-
params: { show_rates: true }
|
128
|
+
include: [:shipping_rates, :stock_location]
|
130
129
|
).serializable_hash
|
131
130
|
end
|
132
131
|
end
|
@@ -0,0 +1,27 @@
|
|
1
|
+
module Spree
|
2
|
+
module Api
|
3
|
+
module V2
|
4
|
+
module Storefront
|
5
|
+
class StoresController < ::Spree::Api::V2::BaseController
|
6
|
+
def show
|
7
|
+
render_serialized_payload { serialize_resource(resource) }
|
8
|
+
end
|
9
|
+
|
10
|
+
private
|
11
|
+
|
12
|
+
def scope
|
13
|
+
Spree::Store
|
14
|
+
end
|
15
|
+
|
16
|
+
def resource
|
17
|
+
scope.find_by!(code: params[:code])
|
18
|
+
end
|
19
|
+
|
20
|
+
def resource_serializer
|
21
|
+
Spree::Api::Dependencies.storefront_store_serializer.constantize
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
26
|
+
end
|
27
|
+
end
|
@@ -13,7 +13,9 @@ module Spree
|
|
13
13
|
:storefront_country_serializer, :storefront_current_order_finder, :storefront_completed_order_finder, :storefront_order_sorter,
|
14
14
|
:storefront_collection_paginator, :storefront_user_serializer, :storefront_products_sorter, :storefront_products_finder,
|
15
15
|
:storefront_product_serializer, :storefront_taxon_serializer, :storefront_taxon_finder, :storefront_find_by_variant_finder,
|
16
|
-
:storefront_cart_update_service, :storefront_cart_estimate_shipping_rates_service, :storefront_estimated_shipment_serializer
|
16
|
+
:storefront_cart_update_service, :storefront_cart_estimate_shipping_rates_service, :storefront_estimated_shipment_serializer,
|
17
|
+
:storefront_store_serializer, :storefront_address_serializer, :storefront_order_serializer,
|
18
|
+
:storefront_account_create_address_service, :storefront_account_update_address_service, :storefront_address_finder
|
17
19
|
].freeze
|
18
20
|
|
19
21
|
attr_accessor *INJECTION_POINTS
|
@@ -48,7 +50,12 @@ module Spree
|
|
48
50
|
@storefront_checkout_remove_store_credit_service = Spree::Dependencies.checkout_remove_store_credit_service
|
49
51
|
@storefront_checkout_get_shipping_rates_service = Spree::Dependencies.checkout_get_shipping_rates_service
|
50
52
|
|
53
|
+
# account services
|
54
|
+
@storefront_account_create_address_service = Spree::Dependencies.account_create_address_service
|
55
|
+
@storefront_account_update_address_service = Spree::Dependencies.account_update_address_service
|
56
|
+
|
51
57
|
# serializers
|
58
|
+
@storefront_address_serializer = 'Spree::V2::Storefront::AddressSerializer'
|
52
59
|
@storefront_cart_serializer = 'Spree::V2::Storefront::CartSerializer'
|
53
60
|
@storefront_credit_card_serializer = 'Spree::V2::Storefront::CreditCardSerializer'
|
54
61
|
@storefront_country_serializer = 'Spree::V2::Storefront::CountrySerializer'
|
@@ -58,6 +65,8 @@ module Spree
|
|
58
65
|
@storefront_payment_method_serializer = 'Spree::V2::Storefront::PaymentMethodSerializer'
|
59
66
|
@storefront_product_serializer = 'Spree::V2::Storefront::ProductSerializer'
|
60
67
|
@storefront_estimated_shipment_serializer = 'Spree::V2::Storefront::EstimatedShippingRateSerializer'
|
68
|
+
@storefront_store_serializer = 'Spree::V2::Storefront::StoreSerializer'
|
69
|
+
@storefront_order_serializer = 'Spree::V2::Storefront::CartSerializer'
|
61
70
|
|
62
71
|
# sorters
|
63
72
|
@storefront_order_sorter = Spree::Dependencies.order_sorter
|
@@ -67,6 +76,7 @@ module Spree
|
|
67
76
|
@storefront_collection_paginator = Spree::Dependencies.collection_paginator
|
68
77
|
|
69
78
|
# finders
|
79
|
+
@storefront_address_finder = Spree::Dependencies.address_finder
|
70
80
|
@storefront_country_finder = Spree::Dependencies.country_finder
|
71
81
|
@storefront_current_order_finder = Spree::Dependencies.current_order_finder
|
72
82
|
@storefront_completed_order_finder = Spree::Dependencies.completed_order_finder
|
@@ -8,7 +8,9 @@ module Spree
|
|
8
8
|
:updated_at, :completed_at, :included_tax_total, :additional_tax_total, :display_additional_tax_total,
|
9
9
|
:display_included_tax_total, :tax_total, :currency, :state, :token, :email,
|
10
10
|
:display_item_total, :display_ship_total, :display_adjustment_total, :display_tax_total,
|
11
|
-
:promo_total, :display_promo_total, :item_count, :special_instructions, :display_total
|
11
|
+
:promo_total, :display_promo_total, :item_count, :special_instructions, :display_total,
|
12
|
+
:pre_tax_item_amount, :display_pre_tax_item_amount, :pre_tax_total, :display_pre_tax_total,
|
13
|
+
:shipment_state, :payment_state
|
12
14
|
|
13
15
|
has_many :line_items
|
14
16
|
has_many :variants
|
@@ -9,7 +9,8 @@ module Spree
|
|
9
9
|
:display_adjustment_total, :additional_tax_total,
|
10
10
|
:discounted_amount, :display_discounted_amount,
|
11
11
|
:display_additional_tax_total, :promo_total, :display_promo_total,
|
12
|
-
:included_tax_total, :display_included_tax_total
|
12
|
+
:included_tax_total, :display_included_tax_total,
|
13
|
+
:pre_tax_amount, :display_pre_tax_amount
|
13
14
|
|
14
15
|
belongs_to :variant
|
15
16
|
end
|
@@ -0,0 +1,13 @@
|
|
1
|
+
module Spree
|
2
|
+
module V2
|
3
|
+
module Storefront
|
4
|
+
class StoreSerializer < BaseSerializer
|
5
|
+
set_type :store
|
6
|
+
|
7
|
+
attributes :name, :url, :meta_description, :meta_keywords, :seo_title, :default_currency, :default, :supported_currencies, :facebook,
|
8
|
+
:twitter, :instagram, :default_locale, :customer_support_email, :default_country_id, :description,
|
9
|
+
:address, :contact_phone, :contact_email
|
10
|
+
end
|
11
|
+
end
|
12
|
+
end
|
13
|
+
end
|
data/config/routes.rb
CHANGED
@@ -152,6 +152,7 @@ Spree::Core::Engine.add_routes do
|
|
152
152
|
resource :account, controller: :account, only: %i[show]
|
153
153
|
|
154
154
|
namespace :account do
|
155
|
+
resources :addresses, controller: :addresses, only: %i[index create update]
|
155
156
|
resources :credit_cards, controller: :credit_cards, only: %i[index show]
|
156
157
|
resources :orders, controller: :orders, only: %i[index show]
|
157
158
|
end
|
@@ -161,6 +162,7 @@ Spree::Core::Engine.add_routes do
|
|
161
162
|
get '/order_status/:number', to: 'order_status#show', as: :order_status
|
162
163
|
resources :products, only: %i[index show]
|
163
164
|
resources :taxons, only: %i[index show], id: /.+/
|
165
|
+
get '/stores/:code', to: 'stores#show', as: :store
|
164
166
|
end
|
165
167
|
end
|
166
168
|
|
@@ -1125,6 +1125,14 @@ components:
|
|
1125
1125
|
company:
|
1126
1126
|
type: string
|
1127
1127
|
example: 'Google Inc.'
|
1128
|
+
AddressList:
|
1129
|
+
required:
|
1130
|
+
- data
|
1131
|
+
properties:
|
1132
|
+
data:
|
1133
|
+
type: array
|
1134
|
+
items:
|
1135
|
+
$ref: '#/components/schemas/Address'
|
1128
1136
|
Cart:
|
1129
1137
|
required:
|
1130
1138
|
- data
|
@@ -1291,6 +1299,18 @@ components:
|
|
1291
1299
|
display_tax_total:
|
1292
1300
|
type: string
|
1293
1301
|
example: '$10.00'
|
1302
|
+
pre_tax_item_amount:
|
1303
|
+
type: string
|
1304
|
+
example: '17.00'
|
1305
|
+
display_pre_tax_item_amount:
|
1306
|
+
type: string
|
1307
|
+
example: '$17.00'
|
1308
|
+
pre_tax_total:
|
1309
|
+
type: string
|
1310
|
+
example: '20.00'
|
1311
|
+
display_pre_tax_total:
|
1312
|
+
type: string
|
1313
|
+
example: '$20.00'
|
1294
1314
|
item_count:
|
1295
1315
|
type: number
|
1296
1316
|
example: 2
|
@@ -1503,6 +1523,12 @@ components:
|
|
1503
1523
|
display_discounted_amount:
|
1504
1524
|
type: string
|
1505
1525
|
example: '$125.00'
|
1526
|
+
pre_tax_amount:
|
1527
|
+
type: string
|
1528
|
+
example: '125.0'
|
1529
|
+
display_pre_tax_amount:
|
1530
|
+
type: string
|
1531
|
+
example: '$125.00'
|
1506
1532
|
promo_total:
|
1507
1533
|
type: string
|
1508
1534
|
example: '-5.0'
|
@@ -4,7 +4,7 @@ shared_context 'API v2 tokens' do
|
|
4
4
|
let(:headers_order_token) { { 'X-Spree-Order-Token' => order.token } }
|
5
5
|
end
|
6
6
|
|
7
|
-
[200, 201, 400, 404, 403, 422].each do |status_code|
|
7
|
+
[200, 201, 400, 401, 404, 403, 422].each do |status_code|
|
8
8
|
shared_examples "returns #{status_code} HTTP status" do
|
9
9
|
it "returns #{status_code}" do
|
10
10
|
expect(response.status).to eq(status_code)
|
@@ -27,6 +27,8 @@ shared_examples 'returns valid cart JSON' do
|
|
27
27
|
expect(json_response['data']).to have_type('cart')
|
28
28
|
expect(json_response['data']).to have_attribute(:number).with_value(order.number)
|
29
29
|
expect(json_response['data']).to have_attribute(:state).with_value(order.state)
|
30
|
+
expect(json_response['data']).to have_attribute(:payment_state).with_value(order.payment_state)
|
31
|
+
expect(json_response['data']).to have_attribute(:shipment_state).with_value(order.shipment_state)
|
30
32
|
expect(json_response['data']).to have_attribute(:token).with_value(order.token)
|
31
33
|
expect(json_response['data']).to have_attribute(:total).with_value(order.total.to_s)
|
32
34
|
expect(json_response['data']).to have_attribute(:item_total).with_value(order.item_total.to_s)
|
@@ -48,6 +50,10 @@ shared_examples 'returns valid cart JSON' do
|
|
48
50
|
expect(json_response['data']).to have_attribute(:promo_total).with_value(order.promo_total.to_s)
|
49
51
|
expect(json_response['data']).to have_attribute(:display_promo_total).with_value(order.display_promo_total.to_s)
|
50
52
|
expect(json_response['data']).to have_attribute(:display_total).with_value(order.display_total.to_s)
|
53
|
+
expect(json_response['data']).to have_attribute(:pre_tax_item_amount).with_value(order.pre_tax_item_amount.to_s)
|
54
|
+
expect(json_response['data']).to have_attribute(:display_pre_tax_item_amount).with_value(order.display_pre_tax_item_amount.to_s)
|
55
|
+
expect(json_response['data']).to have_attribute(:pre_tax_total).with_value(order.pre_tax_total.to_s)
|
56
|
+
expect(json_response['data']).to have_attribute(:display_pre_tax_total).with_value(order.display_pre_tax_total.to_s)
|
51
57
|
expect(json_response['data']).to have_relationships(:user, :line_items, :variants, :billing_address, :shipping_address, :payments, :shipments, :promotions)
|
52
58
|
end
|
53
59
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: spree_api
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 4.1.
|
4
|
+
version: 4.1.13
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Ryan Bigg
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2020-
|
11
|
+
date: 2020-12-15 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: jsonapi-rspec
|
@@ -30,14 +30,14 @@ dependencies:
|
|
30
30
|
requirements:
|
31
31
|
- - '='
|
32
32
|
- !ruby/object:Gem::Version
|
33
|
-
version: 4.1.
|
33
|
+
version: 4.1.13
|
34
34
|
type: :runtime
|
35
35
|
prerelease: false
|
36
36
|
version_requirements: !ruby/object:Gem::Requirement
|
37
37
|
requirements:
|
38
38
|
- - '='
|
39
39
|
- !ruby/object:Gem::Version
|
40
|
-
version: 4.1.
|
40
|
+
version: 4.1.13
|
41
41
|
- !ruby/object:Gem::Dependency
|
42
42
|
name: rabl
|
43
43
|
requirement: !ruby/object:Gem::Requirement
|
@@ -133,6 +133,7 @@ files:
|
|
133
133
|
- app/controllers/spree/api/v1/variants_controller.rb
|
134
134
|
- app/controllers/spree/api/v1/zones_controller.rb
|
135
135
|
- app/controllers/spree/api/v2/base_controller.rb
|
136
|
+
- app/controllers/spree/api/v2/storefront/account/addresses_controller.rb
|
136
137
|
- app/controllers/spree/api/v2/storefront/account/credit_cards_controller.rb
|
137
138
|
- app/controllers/spree/api/v2/storefront/account/orders_controller.rb
|
138
139
|
- app/controllers/spree/api/v2/storefront/account_controller.rb
|
@@ -141,6 +142,7 @@ files:
|
|
141
142
|
- app/controllers/spree/api/v2/storefront/countries_controller.rb
|
142
143
|
- app/controllers/spree/api/v2/storefront/order_status_controller.rb
|
143
144
|
- app/controllers/spree/api/v2/storefront/products_controller.rb
|
145
|
+
- app/controllers/spree/api/v2/storefront/stores_controller.rb
|
144
146
|
- app/controllers/spree/api/v2/storefront/taxons_controller.rb
|
145
147
|
- app/helpers/spree/api/api_helpers.rb
|
146
148
|
- app/helpers/spree/api/v2/collection_options_helpers.rb
|
@@ -166,9 +168,12 @@ files:
|
|
166
168
|
- app/serializers/spree/v2/storefront/shipment_serializer.rb
|
167
169
|
- app/serializers/spree/v2/storefront/shipping_rate_serializer.rb
|
168
170
|
- app/serializers/spree/v2/storefront/state_serializer.rb
|
171
|
+
- app/serializers/spree/v2/storefront/stock_location_serializer.rb
|
172
|
+
- app/serializers/spree/v2/storefront/store_credit_category_serializer.rb
|
169
173
|
- app/serializers/spree/v2/storefront/store_credit_event_serializer.rb
|
170
174
|
- app/serializers/spree/v2/storefront/store_credit_serializer.rb
|
171
175
|
- app/serializers/spree/v2/storefront/store_credit_type_serializer.rb
|
176
|
+
- app/serializers/spree/v2/storefront/store_serializer.rb
|
172
177
|
- app/serializers/spree/v2/storefront/taxon_image_serializer.rb
|
173
178
|
- app/serializers/spree/v2/storefront/taxon_serializer.rb
|
174
179
|
- app/serializers/spree/v2/storefront/taxonomy_serializer.rb
|
@@ -302,9 +307,9 @@ licenses:
|
|
302
307
|
- BSD-3-Clause
|
303
308
|
metadata:
|
304
309
|
bug_tracker_uri: https://github.com/spree/spree/issues
|
305
|
-
changelog_uri: https://github.com/spree/spree/releases/tag/v4.1.
|
310
|
+
changelog_uri: https://github.com/spree/spree/releases/tag/v4.1.13
|
306
311
|
documentation_uri: https://guides.spreecommerce.org/
|
307
|
-
source_code_uri: https://github.com/spree/spree/tree/v4.1.
|
312
|
+
source_code_uri: https://github.com/spree/spree/tree/v4.1.13
|
308
313
|
post_install_message:
|
309
314
|
rdoc_options: []
|
310
315
|
require_paths:
|