datafoodconsortium-connector-v1 1.4.0.pre.beta2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 28fd8d09adf6b2c2a9b3d9e8f865bb29499e56fa76a8bba2cc566b25b4df98ee
+  data.tar.gz: 6cb8596a4ec6b5034a21854e9b8f336b170d7975e9ea116247dd10103919342d
+SHA512:
+  metadata.gz: cea6c4229915a9d6fdb09b8e70ae2854bff050d12029f4ba3eca72f07b7201ca17b064870d36d2e2513ed1b23ab67a89139bd6c858e5c354c05dda1aa1b3b6a9
+  data.tar.gz: bbddded1ea0201d0085f9870fa135036706dd13270ee35d476884fdee4f46bf1702bb07285e654202151633b8e8d92c8346ad56fd76ae415cf4931b9aeef338d

data/lib/datafoodconsortium/connector/address.rb

@@ -0,0 +1,81 @@
+# MIT License
+# 
+# Copyright (c) 2023 Maxime Lecoq <maxime@lecoqlibre.fr>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+
+require "virtual_assembly/semantizer"
+
+class DataFoodConsortium::Connector::Address
+    include VirtualAssembly::Semantizer::SemanticObject
+
+    SEMANTIC_TYPE = "dfc-b:Address".freeze
+
+	# @return [String]
+	attr_accessor :street
+
+	# @return [String]
+	attr_accessor :postalCode
+
+	# @return [String]
+	attr_accessor :city
+
+	# @return [String]
+	attr_accessor :country
+
+	# @return [Real]
+	attr_accessor :latitude
+
+	# @return [Real]
+	attr_accessor :longitude
+
+	# @return [String]
+	attr_accessor :region
+
+	# @param semanticId [String]
+	# @param street [String]
+	# @param postalCode [String]
+	# @param city [String]
+	# @param country [String]
+	# @param latitude [Real]
+	# @param longitude [Real]
+	# @param region [String]
+	def initialize(semanticId, street: nil, postalCode: nil, city: nil, country: nil, latitude: nil, longitude: nil, region: nil)
+		super(semanticId)
+		@street = street
+		@postalCode = postalCode
+		@city = city
+		@country = country
+		@latitude = latitude
+		@longitude = longitude
+		@region = region
+		self.semanticType = "dfc-b:Address"
+		registerSemanticProperty("dfc-b:hasStreet", &method("street")).valueSetter = method("street=")
+		registerSemanticProperty("dfc-b:hasPostalCode", &method("postalCode")).valueSetter = method("postalCode=")
+		registerSemanticProperty("dfc-b:hasCity", &method("city")).valueSetter = method("city=")
+		registerSemanticProperty("dfc-b:hasCountry", &method("country")).valueSetter = method("country=")
+		registerSemanticProperty("dfc-b:latitude", &method("latitude")).valueSetter = method("latitude=")
+		registerSemanticProperty("dfc-b:longitude", &method("longitude")).valueSetter = method("longitude=")
+		registerSemanticProperty("dfc-b:region", &method("region")).valueSetter = method("region=")
+	end
+	
+
+
+end

data/lib/datafoodconsortium/connector/agent.rb

@@ -0,0 +1,76 @@
+# MIT License
+# 
+# Copyright (c) 2023 Maxime Lecoq <maxime@lecoqlibre.fr>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+
+
+require "virtual_assembly/semantizer"
+
+class DataFoodConsortium::Connector::Agent
+    include VirtualAssembly::Semantizer::SemanticObject
+
+    SEMANTIC_TYPE = "dfc-b:Agent".freeze
+
+	# @return [IAddress]
+	attr_accessor :localizations
+
+	# @return [IPhoneNumber]
+	attr_accessor :phoneNumbers
+
+	# @return [String]
+	attr_accessor :emails
+
+	# @return [String]
+	attr_accessor :websites
+
+	# @return [ISocialMedia]
+	attr_accessor :socialMedias
+
+	# @return [String]
+	attr_accessor :logo
+
+	# @param semanticId [String]
+	# @param localizations [IAddress]
+	# @param phoneNumbers [IPhoneNumber]
+	# @param emails [String]
+	# @param websites [String]
+	# @param socialMedias [ISocialMedia]
+	# @param logo [String]
+	def initialize(semanticId, localizations: [], phoneNumbers: [], emails: [], websites: [], socialMedias: [], logo: nil)
+		super(semanticId)
+		@localizations = localizations
+		@phoneNumbers = phoneNumbers
+		@emails = emails
+		@websites = websites
+		@socialMedias = socialMedias
+		@logo = logo
+		self.semanticType = "dfc-b:Agent"
+		registerSemanticProperty("dfc-b:hasAddress", &method("localizations")).valueSetter = method("localizations=")
+		registerSemanticProperty("dfc-b:hasPhoneNumber", &method("phoneNumbers")).valueSetter = method("phoneNumbers=")
+		registerSemanticProperty("dfc-b:email", &method("emails")).valueSetter = method("emails=")
+		registerSemanticProperty("dfc-b:websitePage", &method("websites")).valueSetter = method("websites=")
+		registerSemanticProperty("dfc-b:hasSocialMedia", &method("socialMedias")).valueSetter = method("socialMedias=")
+		registerSemanticProperty("dfc-b:logo", &method("logo")).valueSetter = method("logo=")
+	end
+	
+
+
+end

data/lib/datafoodconsortium/connector/allergen_characteristic.rb

@@ -0,0 +1,51 @@
+# MIT License
+# 
+# Copyright (c) 2023 Maxime Lecoq <maxime@lecoqlibre.fr>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require "datafoodconsortium/connector/characteristic"
+
+
+require "virtual_assembly/semantizer"
+
+class DataFoodConsortium::Connector::AllergenCharacteristic < DataFoodConsortium::Connector::Characteristic
+
+    SEMANTIC_TYPE = "dfc-b:AllergenCharacteristic".freeze
+
+	# @return [ISKOSConcept]
+	attr_accessor :allergenDimension
+
+	# @param allergenDimension [ISKOSConcept]
+	# @param unit [ISKOSConcept]
+	# @param value [Real]
+	def initialize(allergenDimension: nil, unit: nil, value: nil)
+		super(unit: unit, value: value)
+		@allergenDimension = allergenDimension
+		self.semanticType = "dfc-b:AllergenCharacteristic"
+		registerSemanticProperty("dfc-b:hasAllergenDimension", &method("allergenDimension")).valueSetter = method("allergenDimension=")
+	end
+	
+
+	
+
+	
+
+
+end

data/lib/datafoodconsortium/connector/catalog.rb

@@ -0,0 +1,54 @@
+# MIT License
+# 
+# Copyright (c) 2023 Maxime Lecoq <maxime@lecoqlibre.fr>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+
+
+
+
+require "virtual_assembly/semantizer"
+
+class DataFoodConsortium::Connector::Catalog
+    include VirtualAssembly::Semantizer::SemanticObject
+
+    SEMANTIC_TYPE = "dfc-b:Catalog".freeze
+
+	# @return [ICatalogItem]
+	attr_accessor :items
+
+	# @return [IEnterprise]
+	attr_accessor :maintainers
+
+	# @param semanticId [String]
+	# @param items [ICatalogItem]
+	# @param maintainers [IEnterprise]
+	def initialize(semanticId, items: [], maintainers: [])
+		super(semanticId)
+		@items = items
+		@maintainers = maintainers
+		self.semanticType = "dfc-b:Catalog"
+		registerSemanticProperty("dfc-b:lists", &method("items")).valueSetter = method("items=")
+		registerSemanticProperty("dfc-b:maintainedBy", &method("maintainers")).valueSetter = method("maintainers=")
+	end
+	
+
+
+end

data/lib/datafoodconsortium/connector/catalog_item.rb

@@ -0,0 +1,72 @@
+# MIT License
+# 
+# Copyright (c) 2023 Maxime Lecoq <maxime@lecoqlibre.fr>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+
+
+
+
+require "virtual_assembly/semantizer"
+
+class DataFoodConsortium::Connector::CatalogItem
+    include VirtualAssembly::Semantizer::SemanticObject
+
+    SEMANTIC_TYPE = "dfc-b:CatalogItem".freeze
+
+	# @return [IDefinedProduct]
+	attr_accessor :product
+
+	# @return [String]
+	attr_accessor :sku
+
+	# @return [Real]
+	attr_accessor :stockLimitation
+
+	# @return [IOffer]
+	attr_accessor :offers
+
+	# @return [ICatalog]
+	attr_accessor :catalogs
+
+	# @param semanticId [String]
+	# @param product [IDefinedProduct]
+	# @param sku [String]
+	# @param stockLimitation [Real]
+	# @param offers [IOffer]
+	# @param catalogs [ICatalog]
+	def initialize(semanticId, product: nil, sku: nil, stockLimitation: nil, offers: [], catalogs: [])
+		super(semanticId)
+		@product = product
+		@sku = sku
+		@stockLimitation = stockLimitation
+		@offers = offers
+		@catalogs = catalogs
+		self.semanticType = "dfc-b:CatalogItem"
+		registerSemanticProperty("dfc-b:references", &method("product")).valueSetter = method("product=")
+		registerSemanticProperty("dfc-b:sku", &method("sku")).valueSetter = method("sku=")
+		registerSemanticProperty("dfc-b:stockLimitation", &method("stockLimitation")).valueSetter = method("stockLimitation=")
+		registerSemanticProperty("dfc-b:offeredThrough", &method("offers")).valueSetter = method("offers=")
+		registerSemanticProperty("dfc-b:listedIn", &method("catalogs")).valueSetter = method("catalogs=")
+	end
+	
+
+
+end

data/lib/datafoodconsortium/connector/characteristic.rb

@@ -0,0 +1,46 @@
+# MIT License
+# 
+# Copyright (c) 2023 Maxime Lecoq <maxime@lecoqlibre.fr>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+
+
+require "datafoodconsortium/connector/quantitative_value"
+require "virtual_assembly/semantizer"
+
+class DataFoodConsortium::Connector::Characteristic < DataFoodConsortium::Connector::QuantitativeValue
+
+
+	# @param unit [ISKOSConcept]
+	# @param value [Real]
+	def initialize(unit: nil, value: nil)
+		super(unit: unit, value: value)
+		
+		
+		
+	end
+	
+
+	
+
+	
+
+
+end

data/lib/datafoodconsortium/connector/connector.rb

@@ -0,0 +1,84 @@
+# MIT License
+# 
+# Copyright (c) 2023 Maxime Lecoq <maxime@lecoqlibre.fr>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'singleton'
+require 'datafoodconsortium/connector/context'
+require 'datafoodconsortium/connector/importer'
+require 'datafoodconsortium/connector/json_ld_serializer'
+
+module DataFoodConsortium::Connector
+  class Connector
+    include Singleton
+
+    attr_accessor :context
+
+    attr_reader :FACETS
+    attr_reader :MEASURES
+    attr_reader :PRODUCT_TYPES
+
+    def export(*subjects)
+        @exporter.process(*subjects)
+    end
+
+    def import(json_string_or_io)
+        Importer.new.import(json_string_or_io)
+    end
+
+    def loadFacets(data)
+        @FACETS = loadThesaurus(data)
+    end
+
+    def loadMeasures(data)
+        @MEASURES = loadThesaurus(data)
+    end
+
+    def loadProductTypes(data)
+        @PRODUCT_TYPES = loadThesaurus(data)
+    end
+
+    private
+
+    def initialize()
+        super()
+
+        # used to prefix properties
+        # so the DFC's context can be used.
+        # See https://github.com/datafoodconsortium/connector-ruby/issues/11.
+        inputContext = Context.inputContext
+
+        @context = Context::URL
+
+        @exporter = JsonLdSerializer.new(@context, inputContext)
+        @parser = SKOSParser.new
+
+        @FACETS = []
+        @MEASURES = []
+        @PRODUCT_TYPES = []
+    end
+    
+    def loadThesaurus(data)
+        # The root element may be an array or the ontology.
+        data = data[0] if data.is_a?(Array)
+        @parser.parse(data["@graph"])
+    end
+  end
+end

data/lib/datafoodconsortium/connector/context.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'json/ld'
+
+module DataFoodConsortium
+  module Connector
+    # Preload the DFC context.
+    #
+    # Similar to: https://github.com/ruby-rdf/json-ld-preloaded/
+    class Context < JSON::LD::Context
+      URL = "https://w3id.org/dfc/ontology/context/context_1.16.0.json"
+      URL_NORMALISED = "http://w3id.org/dfc/ontology/context/context_1.16.0.json"
+
+      # All context URIs have to use http because https is normalised to http
+      # during the lookup of preloaded contexts.
+      # And if the URI doesn't have a path, it must end with `/`.
+      add_preloaded(URL_NORMALISED) { parse(json) }
+
+      # The default context always pointing to the latest version:
+      alias_preloaded("http://www.datafoodconsortium.org/", URL_NORMALISED)
+
+      # This is the current file the DFC website refers to in a link header.
+      alias_preloaded(
+        "http://www.datafoodconsortium.org/wp-content/plugins/wordpress-context-jsonld/context_1.16.0.jsonld",
+        URL_NORMALISED
+      )
+
+      # This was the file the DFC website refers to in a link header.
+      alias_preloaded(
+        "http://www.datafoodconsortium.org/wp-content/plugins/wordpress-context-jsonld/context.jsonld",
+        URL_NORMALISED
+      )
+
+      # This is the old URL that's not online anymore.
+      # Keep it for compatiblity with all versions before 1.8.
+      alias_preloaded(
+        "http://static.datafoodconsortium.org/ontologies/context.json",
+        URL_NORMALISED
+      )
+
+      # The hash serializer expects only string values in the context.
+      def self.inputContext
+        @inputContext = json.select { |key, value| value.is_a? String }
+      end
+
+      def self.json
+        @json ||= JSON.parse(File.read("#{__dir__}/context_1.16.0.json"))["@context"]
+      end
+    end
+  end
+end