raggedstaff/openfoodnetwork
1
0
Fork 0
mirror of https://github.com/openfoodfoundation/openfoodnetwork synced 2026-01-24 20:36:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Encapsulate dfc_provider in api routing

Browse Source 
Move /api/v0/dfc_provider to /api/dfc_provider. Before it got redirected
to v0 which caused some errors.
This commit is contained in:
Maikel Linke
2022-11-02 15:04:56 +11:00
committed by David Cook
parent f25fb19fe8
commit a501bc9687
22 changed files with 174 additions and 185 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.rubocop_todo.yml
View File

@@ -681,7 +681,7 @@ Rails/ActiveRecordOverride:
# This cop supports unsafe autocorrection (--autocorrect-all).
Rails/ApplicationController:
Exclude:
- 'engines/dfc_provider/app/controllers/dfc_provider/api/base_controller.rb'
- 'engines/dfc_provider/app/controllers/dfc_provider/base_controller.rb'
# Offense count: 6
# This cop supports unsafe autocorrection (--autocorrect-all).

5
config/routes.rb
View File

@@ -117,11 +117,6 @@ Openfoodnetwork::Application.routes.draw do
get 'sitemap.xml', to: 'sitemap#index', defaults: { format: 'xml' }
constraints FeatureToggleConstraint.new(:dfc_provider) do
# Mount DFC API endpoints
mount DfcProvider::Engine, at: '/'
end
# Mount Spree's routes
mount Spree::Core::Engine, :at => '/'

6
config/routes/api.rb
View File

@@ -5,6 +5,12 @@ Openfoodnetwork::Application.routes.draw do
end
namespace :api do
constraints FeatureToggleConstraint.new(:dfc_provider) do
# Mount DFC API endpoints
mount DfcProvider::Engine, at: '/'
end
namespace :v0 do
resources :products do
collection do

65
engines/dfc_provider/app/controllers/dfc_provider/api/base_controller.rb
View File

@@ -1,65 +0,0 @@
# frozen_string_literal: true
# Controller used to provide the API products for the DFC application
module DfcProvider
module Api
class BaseController < ActionController::Base
rescue_from ActiveRecord::RecordNotFound, with: :not_found
before_action :check_authorization,
:check_user
respond_to :json
private
def check_authorization
return if access_token.present?
head :unprocessable_entity
end
def check_user
return if current_user.present?
head :unauthorized
end
def check_enterprise
return if current_enterprise.present?
not_found
end
def current_enterprise
@current_enterprise ||=
case params[enterprise_id_param_name]
when 'default'
current_user.enterprises.first!
else
current_user.enterprises.find(params[enterprise_id_param_name])
end
end
def enterprise_id_param_name
:enterprise_id
end
def current_user
@current_user ||= authorization_control.process
end
def access_token
request.headers['Authorization'].to_s.split(' ').last
end
def authorization_control
DfcProvider::AuthorizationControl.new(access_token)
end
def not_found
head :not_found
end
end
end
end

30
engines/dfc_provider/app/controllers/dfc_provider/api/catalog_items_controller.rb
View File

@@ -1,30 +0,0 @@
# frozen_string_literal: true
# Controller used to provide the API products for the DFC application
# CatalogItems are items that are being sold by the entreprise.
module DfcProvider
module Api
class CatalogItemsController < DfcProvider::Api::BaseController
before_action :check_enterprise
def index
# CatalogItem is nested into an entreprise which is also nested into
# an user on the DFC specifications, as defined here:
# https://datafoodconsortium.gitbook.io/dfc-standard-documentation
# /technical-specification/api-examples
render json: current_user, serializer: DfcProvider::PersonSerializer
end
def show
render json: variant, serializer: DfcProvider::CatalogItemSerializer
end
private
def variant
@variant ||=
DfcProvider::VariantFetcher.new(current_enterprise).scope.find(params[:id])
end
end
end
end

20
engines/dfc_provider/app/controllers/dfc_provider/api/enterprises_controller.rb
View File

@@ -1,20 +0,0 @@
# frozen_string_literal: true
# Controller used to provide the CatalogItem API for the DFC application
module DfcProvider
module Api
class EnterprisesController < DfcProvider::Api::BaseController
before_action :check_enterprise
def show
render json: current_enterprise, serializer: DfcProvider::EnterpriseSerializer
end
private
def enterprise_id_param_name
:id
end
end
end
end

26
engines/dfc_provider/app/controllers/dfc_provider/api/persons_controller.rb
View File

@@ -1,26 +0,0 @@
# frozen_string_literal: true
# Controller used to provide the Persons API for the DFC application
module DfcProvider
module Api
class PersonsController < DfcProvider::Api::BaseController
before_action :check_user_accessibility
def show
render json: user, serializer: DfcProvider::PersonSerializer
end
private
def user
@user ||= Spree::User.find(params[:id])
end
def check_user_accessibility
return if current_user == user
not_found
end
end
end
end

22
engines/dfc_provider/app/controllers/dfc_provider/api/supplied_products_controller.rb
View File

@@ -1,22 +0,0 @@
# frozen_string_literal: true
# Controller used to provide the SuppliedProducts API for the DFC application
# SuppliedProducts are products that are managed by an enterprise.
module DfcProvider
module Api
class SuppliedProductsController < DfcProvider::Api::BaseController
before_action :check_enterprise
def show
render json: variant, serializer: DfcProvider::SuppliedProductSerializer
end
private
def variant
@variant ||=
DfcProvider::VariantFetcher.new(current_enterprise).scope.find(params[:id])
end
end
end
end

63
engines/dfc_provider/app/controllers/dfc_provider/base_controller.rb Normal file
View File

@@ -0,0 +1,63 @@
# frozen_string_literal: true
# Controller used to provide the API products for the DFC application
module DfcProvider
class BaseController < ActionController::Base
rescue_from ActiveRecord::RecordNotFound, with: :not_found
before_action :check_authorization,
:check_user
respond_to :json
private
def check_authorization
return if access_token.present?
head :unprocessable_entity
end
def check_user
return if current_user.present?
head :unauthorized
end
def check_enterprise
return if current_enterprise.present?
not_found
end
def current_enterprise
@current_enterprise ||=
case params[enterprise_id_param_name]
when 'default'
current_user.enterprises.first!
else
current_user.enterprises.find(params[enterprise_id_param_name])
end
end
def enterprise_id_param_name
:enterprise_id
end
def current_user
@current_user ||= authorization_control.process
end
def access_token
request.headers['Authorization'].to_s.split(' ').last
end
def authorization_control
DfcProvider::AuthorizationControl.new(access_token)
end
def not_found
head :not_found
end
end
end

28
engines/dfc_provider/app/controllers/dfc_provider/catalog_items_controller.rb Normal file
View File

@@ -0,0 +1,28 @@
# frozen_string_literal: true
# Controller used to provide the API products for the DFC application
# CatalogItems are items that are being sold by the entreprise.
module DfcProvider
class CatalogItemsController < DfcProvider::BaseController
before_action :check_enterprise
def index
# CatalogItem is nested into an entreprise which is also nested into
# an user on the DFC specifications, as defined here:
# https://datafoodconsortium.gitbook.io/dfc-standard-documentation
# /technical-specification/api-examples
render json: current_user, serializer: DfcProvider::PersonSerializer
end
def show
render json: variant, serializer: DfcProvider::CatalogItemSerializer
end
private
def variant
@variant ||=
DfcProvider::VariantFetcher.new(current_enterprise).scope.find(params[:id])
end
end
end

18
engines/dfc_provider/app/controllers/dfc_provider/enterprises_controller.rb Normal file
View File

@@ -0,0 +1,18 @@
# frozen_string_literal: true
# Controller used to provide the CatalogItem API for the DFC application
module DfcProvider
class EnterprisesController < DfcProvider::BaseController
before_action :check_enterprise
def show
render json: current_enterprise, serializer: DfcProvider::EnterpriseSerializer
end
private
def enterprise_id_param_name
:id
end
end
end

24
engines/dfc_provider/app/controllers/dfc_provider/persons_controller.rb Normal file
View File

@@ -0,0 +1,24 @@
# frozen_string_literal: true
# Controller used to provide the Persons API for the DFC application
module DfcProvider
class PersonsController < DfcProvider::BaseController
before_action :check_user_accessibility
def show
render json: user, serializer: DfcProvider::PersonSerializer
end
private
def user
@user ||= Spree::User.find(params[:id])
end
def check_user_accessibility
return if current_user == user
not_found
end
end
end

20
engines/dfc_provider/app/controllers/dfc_provider/supplied_products_controller.rb Normal file
View File

@@ -0,0 +1,20 @@
# frozen_string_literal: true
# Controller used to provide the SuppliedProducts API for the DFC application
# SuppliedProducts are products that are managed by an enterprise.
module DfcProvider
class SuppliedProductsController < DfcProvider::BaseController
before_action :check_enterprise
def show
render json: variant, serializer: DfcProvider::SuppliedProductSerializer
end
private
def variant
@variant ||=
DfcProvider::VariantFetcher.new(current_enterprise).scope.find(params[:id])
end
end
end

4
engines/dfc_provider/app/serializers/dfc_provider/catalog_item_serializer.rb
View File

@@ -14,7 +14,7 @@ module DfcProvider
key: 'dfc:offeredThrough'
def id
dfc_provider_routes.api_dfc_provider_enterprise_catalog_item_url(
dfc_provider_routes.dfc_provider_enterprise_catalog_item_url(
enterprise_id: object.product.supplier_id,
id: object.id,
host: host
@@ -41,7 +41,7 @@ module DfcProvider
private
def reference_id
dfc_provider_routes.api_dfc_provider_enterprise_supplied_product_url(
dfc_provider_routes.dfc_provider_enterprise_supplied_product_url(
enterprise_id: object.product.supplier_id,
id: object.id,
host: host

2
engines/dfc_provider/app/serializers/dfc_provider/enterprise_serializer.rb
View File

@@ -16,7 +16,7 @@ module DfcProvider
serializer: DfcProvider::CatalogItemSerializer
def id
dfc_provider_routes.api_dfc_provider_enterprise_url(
dfc_provider_routes.dfc_provider_enterprise_url(
id: object.id,
host: host
)

2
engines/dfc_provider/app/serializers/dfc_provider/person_serializer.rb
View File

@@ -26,7 +26,7 @@ module DfcProvider
end
def id
dfc_provider_routes.api_dfc_provider_person_url(
dfc_provider_routes.dfc_provider_person_url(
id: object.id,
host: host
)

2
engines/dfc_provider/app/serializers/dfc_provider/supplied_product_serializer.rb
View File

@@ -17,7 +17,7 @@ module DfcProvider
has_many :physical_characteristics, key: 'dfc:physicalCharacterisctics'
def id
dfc_provider_routes.api_dfc_provider_enterprise_supplied_product_url(
dfc_provider_routes.dfc_provider_enterprise_supplied_product_url(
enterprise_id: object.product.supplier_id,
id: object.id,
host: host

12
engines/dfc_provider/config/routes.rb
View File

@@ -1,13 +1,11 @@
# frozen_string_literal: true
DfcProvider::Engine.routes.draw do
namespace :api do
scope :dfc_provider, as: :dfc_provider, path: '/dfc_provider' do
resources :enterprises, only: [:show] do
resources :catalog_items, only: [:index, :show]
resources :supplied_products, only: [:show]
end
resources :persons, only: [:show]
scope :dfc_provider, as: :dfc_provider, path: '/dfc_provider' do
resources :enterprises, only: [:show] do
resources :catalog_items, only: [:index, :show]
resources :supplied_products, only: [:show]
end
resources :persons, only: [:show]
end
end

2
engines/dfc_provider/spec/controllers/dfc_provider/api/catalog_items_controller_spec.rb → engines/dfc_provider/spec/controllers/dfc_provider/catalog_items_controller_spec.rb
View File

@@ -2,7 +2,7 @@
require 'spec_helper'
describe DfcProvider::Api::CatalogItemsController, type: :controller do
describe DfcProvider::CatalogItemsController, type: :controller do
render_views
let!(:user) { create(:user) }

2
engines/dfc_provider/spec/controllers/dfc_provider/api/enterprises_spec.rb → engines/dfc_provider/spec/controllers/dfc_provider/enterprises_spec.rb
View File

@@ -2,7 +2,7 @@
require 'spec_helper'
describe DfcProvider::Api::EnterprisesController, type: :controller do
describe DfcProvider::EnterprisesController, type: :controller do
render_views
let!(:user) { create(:user) }

2
engines/dfc_provider/spec/controllers/dfc_provider/api/persons_controller_spec.rb → engines/dfc_provider/spec/controllers/dfc_provider/persons_controller_spec.rb
View File

@@ -2,7 +2,7 @@
require 'spec_helper'
describe DfcProvider::Api::PersonsController, type: :controller do
describe DfcProvider::PersonsController, type: :controller do
render_views
let!(:user) { create(:user) }

2
engines/dfc_provider/spec/controllers/dfc_provider/api/supplied_products_controller_spec.rb → engines/dfc_provider/spec/controllers/dfc_provider/supplied_products_controller_spec.rb
View File

@@ -2,7 +2,7 @@
require 'spec_helper'
describe DfcProvider::Api::SuppliedProductsController, type: :controller do
describe DfcProvider::SuppliedProductsController, type: :controller do
render_views
let!(:user) { create(:user) }