OEMSecrets provider interface v.1.0 (#679)

* OEMSecrets provider interface v.1.0

New class for interacting with the OEMSecrets (https://www.oemsecrets.com) API version 3.0.1.

* Refactored info provider to be stateless and independent from session, optimized Part-DB API usage, and fixed PHPStan issues.

Refactored info provider to be stateless and independent from session, now use Psr\Cache, fixed issues identified by PHPStan, additional minor enhancements and bug fixes.

* Prefix cache keys with oemsecrets_ to avoid key collissions

* Use uniqid with more entropy to reduce probability of collisions

* Made $resultData local as it is only used inside searchByKeyword

* Use the parameter name $id from interface declaration for getDetails to avoid problems with named arguments

* Use unicode modifier for preg_match to avoid problems when parameters contain non-unicode strings

* Various small code quality improvements

* Try to retrieve the part from the API in getDetails, if the DTO was not cached before

* Improved code formatting

* Channged OEMSecret default country to DE to be consistent with other default values

* Do not call gc_collect_cycles in the loop to process the results, but only after all processBatch calls

---------

Co-authored-by: Jan Böhmer <[email protected]>

.env

@@ -181,6 +181,40 @@ PROVIDER_LCSC_ENABLED=0
 # The currency to get prices in (e.g. EUR, USD, etc.)
 PROVIDER_LCSC_CURRENCY=EUR
 
+# Oemsecrets Provider API 3.0.1:
+# You can get your API key from https://www.oemsecrets.com/api
+PROVIDER_OEMSECRETS_KEY=
+# The country you want the output for
+PROVIDER_OEMSECRETS_COUNTRY_CODE=DE
+# Available country code are:
+# AD, AE, AQ, AR, AT, AU, BE, BO, BR, BV, BY, CA, CH, CL, CN, CO, CZ, DE, DK, EC, EE, EH, 
+# ES, FI, FK, FO, FR, GB, GE, GF, GG, GI, GL, GR, GS, GY, HK, HM, HR, HU, IE, IM, IN, IS,
+# IT, JM, JP, KP, KR, KZ, LI, LK, LT, LU, MC, MD, ME, MK, MT, NL, NO, NZ, PE, PH, PL, PT, 
+# PY, RO, RS, RU, SB, SD, SE, SG, SI, SJ, SK, SM, SO, SR, SY, SZ, TC, TF, TG, TH, TJ, TK, 
+# TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VE, VG, VI, VN, VU, WF, YE, 
+# ZA, ZM, ZW
+#
+# The currency you want the prices to be displayed in
+PROVIDER_OEMSECRETS_CURRENCY=EUR
+# Available currency are:AUD, CAD, CHF, CNY, DKK, EUR, GBP, HKD, ILS, INR, JPY, KRW, NOK, 
+#                        NZD, RUB, SEK, SGD, TWD, USD
+#
+# If PROVIDER_OEMSECRETS_ZERO_PRICE is set to 0, distributors with zero prices 
+# will be discarded from the creation of a new part (set to 1 otherwise)
+PROVIDER_OEMSECRETS_ZERO_PRICE=0
+#
+# When PROVIDER_OEMSECRETS_SET_PARAM is set to 1 the parameters for the part are generated 
+# from the description transforming unstructured descriptions into structured parameters; 
+# each parameter in description should have the form: "...;name1:value1;name2:value2"
+PROVIDER_OEMSECRETS_SET_PARAM=1
+#
+# This environment variable determines the sorting criteria for product results.
+# The sorting process first arranges items based on the provided keyword.
+# Then, if set to 'C', it further sorts by completeness (prioritizing items with the most
+# detailed information). If set to 'M', it further sorts by manufacturer name.
+#If unset or set to any other value, no sorting is performed.
+PROVIDER_OEMSECRETS_SORT_CRITERIA=C
+
 ##################################################################################
 # EDA integration related settings
 ##################################################################################

config/services.yaml

@@ -306,6 +306,16 @@ services:
             $enabled: '%env(bool:PROVIDER_LCSC_ENABLED)%'
             $currency: '%env(string:PROVIDER_LCSC_CURRENCY)%'
 
+    App\Services\InfoProviderSystem\Providers\OEMSecretsProvider:
+        arguments:
+            $api_key: '%env(string:PROVIDER_OEMSECRETS_KEY)%'
+            $country_code: '%env(string:PROVIDER_OEMSECRETS_COUNTRY_CODE)%'
+            $currency: '%env(PROVIDER_OEMSECRETS_CURRENCY)%'
+            $zero_price: '%env(PROVIDER_OEMSECRETS_ZERO_PRICE)%'
+            $set_param: '%env(PROVIDER_OEMSECRETS_SET_PARAM)%'
+            $sort_criteria: '%env(PROVIDER_OEMSECRETS_SORT_CRITERIA)%'
+
+
     ####################################################################################################################
     # API system
     ####################################################################################################################
@@ -400,4 +410,4 @@ when@test:
             arguments:
                 - '@doctrine.fixtures.loader'
                 - '@doctrine'
-                - { default: '@App\Doctrine\Purger\DoNotUsePurgerFactory' }
+                - { default: '@App\Doctrine\Purger\DoNotUsePurgerFactory' }