raggedstaff/openfoodnetwork
1
0
Fork 0
mirror of https://github.com/openfoodfoundation/openfoodnetwork synced 2026-02-27 01:43:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #11508 from mkllnk/dfc-enterprise-groups

Browse Source 
[DFC API] Add endpoint for enterprise groups
This commit is contained in:
Maikel
2023-09-13 16:50:05 +10:00
committed by GitHub
parent ae72158e87 7e222ad83e
commit 463ecf2880
9 changed files with 195 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
engines/dfc_provider/app/controllers/dfc_provider/catalog_items_controller.rb
View File

@@ -8,6 +8,12 @@ module DfcProvider
def index
person = PersonBuilder.person(current_user)
enterprises = current_user.enterprises.map do |enterprise|
EnterpriseBuilder.enterprise(enterprise)
end
person.affiliatedOrganizations = enterprises
render json: DfcIo.export(
person,
*person.affiliatedOrganizations,

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

@@ -0,0 +1,24 @@
# frozen_string_literal: true
# OFN EnterpriseGroup is represented as DFC Enterprise.
module DfcProvider
class EnterpriseGroupsController < DfcProvider::ApplicationController
def index
person = PersonBuilder.person(current_user)
groups = current_user.owned_groups
enterprises = groups.map do |group|
EnterpriseBuilder.enterprise_group(group)
end
person.affiliatedOrganizations = enterprises
render json: DfcIo.export(person, *enterprises)
end
def show
group = EnterpriseGroup.find(params[:id])
address = AddressBuilder.address(group.address)
enterprise = EnterpriseBuilder.enterprise_group(group)
enterprise.addLocalization(address)
render json: DfcIo.export(enterprise, address)
end
end
end

6
engines/dfc_provider/app/controllers/dfc_provider/enterprises_controller.rb
View File

@@ -7,6 +7,12 @@ module DfcProvider
def show
enterprise = EnterpriseBuilder.enterprise(current_enterprise)
group_ids = current_enterprise.groups.map do |group|
DfcProvider::Engine.routes.url_helpers.enterprise_group_url(group.id)
end
enterprise.registerSemanticProperty("dfc-b:affiliates") { group_ids }
render json: DfcIo.export(
enterprise,
*enterprise.localizations,

18
engines/dfc_provider/app/services/enterprise_builder.rb
View File

@@ -18,4 +18,22 @@ class EnterpriseBuilder < DfcBuilder
e.addLocalization(address)
end
end
def self.enterprise_group(group)
members = group.enterprises.map do |member|
urls.enterprise_url(member.id)
end
DataFoodConsortium::Connector::Enterprise.new(
urls.enterprise_group_url(group.id),
name: group.name,
description: group.description,
).tap do |enterprise|
# This property has been agreed by the DFC but hasn't made it's way into
# the Connector yet.
enterprise.registerSemanticProperty("dfc-b:affiliatedBy") do
members
end
end
end
end

7
engines/dfc_provider/app/services/person_builder.rb
View File

@@ -6,13 +6,6 @@ class PersonBuilder < DfcBuilder
urls.person_url(user.id),
firstName: user.bill_address&.firstname,
lastName: user.bill_address&.lastname,
affiliatedOrganizations: enterprises(user),
)
end
def self.enterprises(user)
user.enterprises.map do |enterprise|
EnterpriseBuilder.enterprise(enterprise)
end
end
end

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

@@ -6,5 +6,6 @@ DfcProvider::Engine.routes.draw do
resources :catalog_items, only: [:index, :show, :update]
resources :supplied_products, only: [:create, :show, :update]
end
resources :enterprise_groups, only: [:index, :show]
resources :persons, only: [:show]
end

70
engines/dfc_provider/spec/requests/enterprise_groups_spec.rb Normal file
View File

@@ -0,0 +1,70 @@
# frozen_string_literal: true
require_relative "../swagger_helper"
describe "EnterpriseGroups", type: :request, swagger_doc: "dfc.yaml", rswag_autodoc: true do
let(:user) { create(:oidc_user, id: 12_345) }
let(:group) {
create(
:enterprise_group,
id: 60_000, owner: user, name: "Sustainable Farmers", address:,
enterprises: [enterprise],
)
}
let(:address) { create(:address, id: 40_000, address1: "8 Acres Drive") }
let(:enterprise) { create(:enterprise, id: 10_000) }
before { login_as user }
path "/api/dfc/enterprise_groups" do
get "List groups" do
produces "application/json"
response "200", "successful" do
let!(:groups) { [group] }
run_test! do
graph = json_response["@graph"]
expect(graph[0]["@type"]).to eq "dfc-b:Person"
expect(graph[0]).to include(
"dfc-b:affiliates" => "http://test.host/api/dfc/enterprise_groups/60000",
)
expect(graph[1]["@type"]).to eq "dfc-b:Enterprise"
expect(graph[1]).to include(
"dfc-b:hasName" => "Sustainable Farmers",
"dfc-b:affiliatedBy" => "http://test.host/api/dfc/enterprises/10000",
)
end
end
end
end
path "/api/dfc/enterprise_groups/{id}" do
get "Show groups" do
parameter name: :id, in: :path, type: :string
produces "application/json"
response "200", "successful" do
let(:id) { group.id }
run_test! do
graph = json_response["@graph"]
expect(graph[0]).to include(
"@type" => "dfc-b:Enterprise",
"dfc-b:hasName" => "Sustainable Farmers",
"dfc-b:hasAddress" => "http://test.host/api/dfc/addresses/40000",
"dfc-b:affiliatedBy" => "http://test.host/api/dfc/enterprises/10000",
)
expect(graph[1]).to include(
"@type" => "dfc-b:Address",
"dfc-b:hasStreet" => "8 Acres Drive",
)
end
end
end
end
end

11
engines/dfc_provider/spec/requests/enterprises_spec.rb
View File

@@ -12,6 +12,13 @@ describe "Enterprises", type: :request, swagger_doc: "dfc.yaml", rswag_autodoc:
address: build(:address, id: 40_000, address1: "42 Doveton Street"),
)
end
let!(:enterprise_group) do
create(
:enterprise_group,
id: 60_000, owner: user, name: "Local Farmers",
enterprises: [enterprise],
)
end
let!(:product) {
create(
:base_product,
@@ -48,6 +55,10 @@ describe "Enterprises", type: :request, swagger_doc: "dfc.yaml", rswag_autodoc:
expect(response.body).to include "123 456"
expect(response.body).to include "Apple"
expect(response.body).to include "42 Doveton Street"
expect(json_response["@graph"][0]).to include(
"dfc-b:affiliates" => "http://test.host/api/dfc/enterprise_groups/60000",
)
end
end
end

59
swagger/dfc.yaml
View File

@@ -234,6 +234,64 @@ paths:
"@type": "@id"
dfc-b:stockLimitation: '3'
dfc-b:sku: new-sku
"/api/dfc/enterprise_groups":
get:
summary: List groups
tags:
- EnterpriseGroups
responses:
'200':
description: successful
content:
application/json:
examples:
test_example:
value:
"@context": https://www.datafoodconsortium.org
"@graph":
- "@id": http://test.host/api/dfc/persons/12345
"@type": dfc-b:Person
dfc-b:affiliates: http://test.host/api/dfc/enterprise_groups/60000
- "@id": http://test.host/api/dfc/enterprise_groups/60000
"@type": dfc-b:Enterprise
dfc-b:hasName: Sustainable Farmers
dfc-b:hasDescription: this is a group
dfc-b:VATnumber: ''
dfc-b:affiliatedBy: http://test.host/api/dfc/enterprises/10000
"/api/dfc/enterprise_groups/{id}":
get:
summary: Show groups
parameters:
- name: id
in: path
required: true
schema:
type: string
tags:
- EnterpriseGroups
responses:
'200':
description: successful
content:
application/json:
examples:
test_example:
value:
"@context": https://www.datafoodconsortium.org
"@graph":
- "@id": http://test.host/api/dfc/enterprise_groups/60000
"@type": dfc-b:Enterprise
dfc-b:hasAddress: http://test.host/api/dfc/addresses/40000
dfc-b:hasName: Sustainable Farmers
dfc-b:hasDescription: this is a group
dfc-b:VATnumber: ''
dfc-b:affiliatedBy: http://test.host/api/dfc/enterprises/10000
- "@id": http://test.host/api/dfc/addresses/40000
"@type": dfc-b:Address
dfc-b:hasStreet: 8 Acres Drive
dfc-b:hasPostalCode: '20170'
dfc-b:hasCity: Herndon
dfc-b:hasCountry: Australia
"/api/dfc/enterprises/{id}":
get:
summary: Show enterprise
@@ -263,6 +321,7 @@ paths:
dfc-b:VATnumber: 123 456
dfc-b:supplies: http://test.host/api/dfc/enterprises/10000/supplied_products/10001
dfc-b:manages: http://test.host/api/dfc/enterprises/10000/catalog_items/10001
dfc-b:affiliates: http://test.host/api/dfc/enterprise_groups/60000
- "@id": http://test.host/api/dfc/addresses/40000
"@type": dfc-b:Address
dfc-b:hasStreet: 42 Doveton Street