Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Added simple shipping/tax categories endpoint for Admin API

Damian Legawiec2ed81fde161a
diff --git a/spree/api/app/controllers/spree/api/v3/admin/shipping_categories_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/shipping_categories_controller.rb
new file mode 100644
index 0000000000..2abf3f4d29
--- /dev/null
+++ b/spree/api/app/controllers/spree/api/v3/admin/shipping_categories_controller.rb
@@ -0,0 +1,19 @@
+module Spree
+ module Api
+ module V3
+ module Admin
+ class ShippingCategoriesController < ResourceController
+ protected
+
+ def model_class
+ Spree::ShippingCategory
+ end
+
+ def serializer_class
+ Spree.api.admin_shipping_category_serializer
+ end
+ end
+ end
+ end
+ end
+end
diff --git a/spree/api/app/controllers/spree/api/v3/admin/tax_categories_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/tax_categories_controller.rb
new file mode 100644
index 0000000000..9f69b43171
--- /dev/null
+++ b/spree/api/app/controllers/spree/api/v3/admin/tax_categories_controller.rb
@@ -0,0 +1,19 @@
+module Spree
+ module Api
+ module V3
+ module Admin
+ class TaxCategoriesController < ResourceController
+ protected
+
+ def model_class
+ Spree::TaxCategory
+ end
+
+ def serializer_class
+ Spree.api.admin_tax_category_serializer
+ end
+ end
+ end
+ end
+ end
+end
diff --git a/spree/api/config/routes.rb b/spree/api/config/routes.rb
index 9fe3f7c83c..11f84b9067 100644
--- a/spree/api/config/routes.rb
+++ b/spree/api/config/routes.rb
@@ -120,6 +120,12 @@ Spree::Core::Engine.add_routes do
# Option Types (with nested option_values in payload)
resources :option_types
+ # Shipping Categories
+ resources :shipping_categories, only: [:index, :show]
+
+ # Tax Categories
+ resources :tax_categories, only: [:index, :show]
+
# Orders
resources :orders do
member do
diff --git a/spree/api/spec/controllers/spree/api/v3/admin/shipping_categories_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/shipping_categories_controller_spec.rb
new file mode 100644
index 0000000000..b3673b5f65
--- /dev/null
+++ b/spree/api/spec/controllers/spree/api/v3/admin/shipping_categories_controller_spec.rb
@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+RSpec.describe Spree::Api::V3::Admin::ShippingCategoriesController, type: :controller do
+ render_views
+
+ include_context 'API v3 Admin authenticated'
+
+ let!(:shipping_category) { create(:shipping_category) }
+
+ before { request.headers.merge!(headers) }
+
+ describe 'GET #index' do
+ subject { get :index, as: :json }
+
+ it 'returns shipping categories' do
+ subject
+ expect(response).to have_http_status(:ok)
+ expect(json_response['data']).to be_an(Array)
+ expect(json_response['data'].map { |sc| sc['id'] }).to include(shipping_category.prefixed_id)
+ end
+ end
+
+ describe 'GET #show' do
+ subject { get :show, params: { id: shipping_category.prefixed_id }, as: :json }
+
+ it 'returns the shipping category' do
+ subject
+ expect(response).to have_http_status(:ok)
+ expect(json_response['id']).to eq(shipping_category.prefixed_id)
+ expect(json_response['name']).to eq(shipping_category.name)
+ end
+ end
+end
diff --git a/spree/api/spec/controllers/spree/api/v3/admin/tax_categories_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/tax_categories_controller_spec.rb
new file mode 100644
index 0000000000..8e6145b43c
--- /dev/null
+++ b/spree/api/spec/controllers/spree/api/v3/admin/tax_categories_controller_spec.rb
@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+RSpec.describe Spree::Api::V3::Admin::TaxCategoriesController, type: :controller do
+ render_views
+
+ include_context 'API v3 Admin authenticated'
+
+ let!(:tax_category) { create(:tax_category) }
+
+ before { request.headers.merge!(headers) }
+
+ describe 'GET #index' do
+ subject { get :index, as: :json }
+
+ it 'returns tax categories' do
+ subject
+ expect(response).to have_http_status(:ok)
+ expect(json_response['data']).to be_an(Array)
+ expect(json_response['data'].map { |tc| tc['id'] }).to include(tax_category.prefixed_id)
+ end
+ end
+
+ describe 'GET #show' do
+ subject { get :show, params: { id: tax_category.prefixed_id }, as: :json }
+
+ it 'returns the tax category' do
+ subject
+ expect(response).to have_http_status(:ok)
+ expect(json_response['id']).to eq(tax_category.prefixed_id)
+ expect(json_response['name']).to eq(tax_category.name)
+ end
+ end
+end