mirror of
https://github.com/Part-DB/Part-DB-server.git
synced 2025-06-20 17:15:51 +02:00
Added the MouserProvider by @pdo59
This commit is contained in:
Jan Böhmer
parent
2409c7f62b
commit
33033bc5b1
3 changed files with 354 additions and 0 deletions
14
.env
14
.env
|
|
@ -142,6 +142,20 @@ PROVIDER_OCTOPART_SEARCH_LIMIT=10
|
|||
# Set to false to include non authorized offers in the results
|
||||
PROVIDER_OCTOPART_ONLY_AUTHORIZED_SELLERS=1
|
||||
|
||||
# Mouser Provider API V2:
|
||||
# You can get your API key from https://www.mouser.it/api-hub/
|
||||
PROVIDER_MOUSER_KEY=
|
||||
# If not provided, the default is false. Used when searching for keywords in the language specified when you signed up for Search API.
|
||||
# Can use string representation: true.
|
||||
PROVIDER_MOUSER_LANGUAGE='true'
|
||||
#searchOptions string
|
||||
#Optional. If not provided, the default is None.
|
||||
#Refers to options supported by the search engine.
|
||||
#Only one value at a time is supported.
|
||||
#Available options: None | Rohs | InStock | RohsAndInStock - can use string representations or integer IDs: 1[None] | 2[Rohs] | 4[InStock] | 8[RohsAndInStock].
|
||||
PROVIDER_MOUSER_OPTION='1'
|
||||
# The number of results to get from Mouser while searching (please note that this value is max 50)
|
||||
PROVIDER_MOUSER_SEARCH_LIMIT=50
|
||||
|
||||
###################################################################################
|
||||
# SAML Single sign on-settings
|
||||
|
|
|
|||
|
|
@ -277,6 +277,13 @@ services:
|
|||
$search_limit: '%env(int:PROVIDER_OCTOPART_SEARCH_LIMIT)%'
|
||||
$onlyAuthorizedSellers: '%env(bool:PROVIDER_OCTOPART_ONLY_AUTHORIZED_SELLERS)%'
|
||||
|
||||
App\Services\InfoProviderSystem\Providers\MouserProvider:
|
||||
arguments:
|
||||
$api_key: '%env(string:PROVIDER_MOUSER_KEY)%'
|
||||
$language: '%env(string:PROVIDER_MOUSER_LANGUAGE)%'
|
||||
$options: '%env(string:PROVIDER_MOUSER_OPTION)%'
|
||||
$search_limit: '%env(int:PROVIDER_MOUSER_SEARCH_LIMIT)%'
|
||||
|
||||
####################################################################################################################
|
||||
# API system
|
||||
####################################################################################################################
|
||||
|
|
|
|||
333
src/Services/InfoProviderSystem/Providers/MouserProvider.php
Normal file
333
src/Services/InfoProviderSystem/Providers/MouserProvider.php
Normal file
|
|
@ -0,0 +1,333 @@
|
|||
<?php
|
||||
/*
|
||||
* This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
|
||||
*
|
||||
* Copyright (C) 2019 - 2023 Jan Böhmer (https://github.com/jbtronics)
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published
|
||||
* by the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
/*
|
||||
* This file provide an interface with the Mouser API V2 (also compatible with the V1)
|
||||
*
|
||||
* Copyright (C) 2023 Pasquale D'Orsi (https://github.com/pdo59)
|
||||
*
|
||||
* TODO: Obtain an API keys with an US Mouser user (currency $) and test the result of prices
|
||||
*
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
|
||||
namespace App\Services\InfoProviderSystem\Providers;
|
||||
|
||||
use App\Entity\Parts\ManufacturingStatus;
|
||||
use App\Form\InfoProviderSystem\ProviderSelectType;
|
||||
use App\Services\InfoProviderSystem\DTOs\FileDTO;
|
||||
use App\Services\InfoProviderSystem\DTOs\ParameterDTO;
|
||||
use App\Services\InfoProviderSystem\DTOs\PartDetailDTO;
|
||||
use App\Services\InfoProviderSystem\DTOs\PriceDTO;
|
||||
use App\Services\InfoProviderSystem\DTOs\SearchResultDTO;
|
||||
use App\Services\InfoProviderSystem\DTOs\PurchaseInfoDTO;
|
||||
use Symfony\Contracts\HttpClient\HttpClientInterface;
|
||||
|
||||
|
||||
class MouserProvider implements InfoProviderInterface
|
||||
{
|
||||
|
||||
private const ENDPOINT_URL = 'https://api.mouser.com/api/v2/search';
|
||||
|
||||
private const NUMBER_OF_RESULTS = 50; //MAX 50
|
||||
|
||||
|
||||
public const DISTRIBUTOR_NAME = 'Mouser';
|
||||
|
||||
public function __construct(private readonly HttpClientInterface $mouserClient,
|
||||
private readonly string $api_key,
|
||||
private readonly string $language,
|
||||
private readonly string $options,
|
||||
private readonly int $search_limit)
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
public function getProviderInfo(): array
|
||||
{
|
||||
return [
|
||||
'name' => 'Mouser',
|
||||
'description' => 'This provider uses the Mouser API to search for parts.',
|
||||
'url' => 'https://www.mouser.com/',
|
||||
'disabled_help' => 'Configure the API key in the PROVIDER_MOUSER_KEY environment variable to enable.'
|
||||
];
|
||||
}
|
||||
|
||||
public function getProviderKey(): string
|
||||
{
|
||||
return 'Mouser';
|
||||
}
|
||||
|
||||
public function isActive(): bool
|
||||
{
|
||||
return !empty($this->api_key);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $term
|
||||
* @return PartDetailDTO[]
|
||||
*/
|
||||
private function queryByTerm(string $term): array
|
||||
{
|
||||
/*
|
||||
SearchByKeywordRequest description:
|
||||
Search parts by keyword and return a maximum of 50 parts.
|
||||
|
||||
keyword* string
|
||||
Used for keyword part search.
|
||||
|
||||
records integer($int32)
|
||||
Used to specify how many records the method should return.
|
||||
|
||||
startingRecord integer($int32)
|
||||
Indicates where in the total recordset the return set should begin.
|
||||
From the startingRecord, the number of records specified will be returned up to the end of the recordset.
|
||||
This is useful for paging through the complete recordset of parts matching keyword.
|
||||
|
||||
searchOptions string
|
||||
Optional.
|
||||
If not provided, the default is None.
|
||||
Refers to options supported by the search engine.
|
||||
Only one value at a time is supported.
|
||||
Available options: None | Rohs | InStock | RohsAndInStock - can use string representations or integer IDs: 1[None] | 2[Rohs] | 4[InStock] | 8[RohsAndInStock].
|
||||
|
||||
searchWithYourSignUpLanguage string
|
||||
Optional.
|
||||
If not provided, the default is false.
|
||||
Used when searching for keywords in the language specified when you signed up for Search API.
|
||||
Can use string representation: true.
|
||||
{
|
||||
"SearchByKeywordRequest": {
|
||||
"keyword": "BC557",
|
||||
"records": 0,
|
||||
"startingRecord": 0,
|
||||
"searchOptions": "",
|
||||
"searchWithYourSignUpLanguage": ""
|
||||
}
|
||||
}
|
||||
*/
|
||||
|
||||
$response = $this->mouserClient->request('POST', self::ENDPOINT_URL . "/keyword?apiKey=" . $this->api_key , [
|
||||
'json' => [
|
||||
'SearchByKeywordRequest' => [
|
||||
'keyword' => $term,
|
||||
'records' => $this->search_limit, //self::NUMBER_OF_RESULTS,
|
||||
'startingRecord' => 0,
|
||||
'searchOptions' => $this->options,
|
||||
'searchWithYourSignUpLanguage' => $this->language,
|
||||
]
|
||||
],
|
||||
]);
|
||||
|
||||
$arr = $response->toArray();
|
||||
if (isset($arr['SearchResults'])) {
|
||||
$products = $arr['SearchResults']['Parts'] ?? [];
|
||||
} else {
|
||||
throw new \RuntimeException('Unknown response format');
|
||||
}
|
||||
$result = [];
|
||||
foreach ($products as $product) {
|
||||
$result[] = new PartDetailDTO(
|
||||
provider_key: $this->getProviderKey(),
|
||||
provider_id: $product['MouserPartNumber'],
|
||||
name: $product['ManufacturerPartNumber'],
|
||||
description: $product['Description'],
|
||||
manufacturer: $product['Manufacturer'],
|
||||
mpn: $product['ManufacturerPartNumber'],
|
||||
preview_image_url: $product['ImagePath'],
|
||||
category: $product['Category'],
|
||||
provider_url: $product['ProductDetailUrl'],
|
||||
manufacturing_status: $this->releaseStatusCodeToManufacturingStatus($product['LifecycleStatus'] ?? null),
|
||||
datasheets: $this->parseDataSheets($product['DataSheetUrl'], $product['MouserPartNumber'] ?? null),
|
||||
vendor_infos: $this->pricingToDTOs($product['PriceBreaks'] ?? [], $product['MouserPartNumber'], $product['ProductDetailUrl']),
|
||||
);
|
||||
}
|
||||
return $result;
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $parte
|
||||
* @return PartDetailDTO[]
|
||||
*/
|
||||
private function queryPartNumber(string $parte): array
|
||||
{
|
||||
/*
|
||||
SearchByPartRequest description:
|
||||
Search parts by part number and return a maximum of 50 parts.
|
||||
|
||||
mouserPartNumber string
|
||||
Used to search parts by the specific Mouser part number with a maximum input of 10 part numbers, separated by a pipe symbol for the search.
|
||||
Each part number must be a minimum of 3 characters and a maximum of 40 characters. For example: 494-JANTX2N2222A|610-2N2222-TL|637-2N2222A
|
||||
|
||||
partSearchOptions string
|
||||
Optional.
|
||||
If not provided, the default is None. Refers to options supported by the search engine. Only one value at a time is supported.
|
||||
The following values are valid: None | Exact - can use string representations or integer IDs: 1[None] | 2[Exact]
|
||||
|
||||
{
|
||||
"SearchByPartRequest": {
|
||||
"mouserPartNumber": "string",
|
||||
"partSearchOptions": "string"
|
||||
}
|
||||
}
|
||||
*/
|
||||
|
||||
$response = $this->mouserClient->request('POST', self::ENDPOINT_URL . "/partnumber?apiKey=" . $this->api_key , [
|
||||
'json' => [
|
||||
'SearchByPartRequest' => [
|
||||
'mouserPartNumber' => $parte,
|
||||
'partSearchOptions' => 2
|
||||
]
|
||||
],
|
||||
]);
|
||||
$arr = $response->toArray();
|
||||
if (isset($arr['SearchResults'])) {
|
||||
$products = $arr['SearchResults']['Parts'] ?? [];
|
||||
} else {
|
||||
throw new \RuntimeException('Unknown response format');
|
||||
}
|
||||
|
||||
$result = [];
|
||||
foreach ($products as $product) {
|
||||
$result[] = new PartDetailDTO(
|
||||
provider_key: $this->getProviderKey(),
|
||||
provider_id: $product['MouserPartNumber'],
|
||||
name: $product['ManufacturerPartNumber'],
|
||||
description: $product['Description'],
|
||||
manufacturer: $product['Manufacturer'],
|
||||
mpn: $product['ManufacturerPartNumber'],
|
||||
preview_image_url: $product['ImagePath'],
|
||||
category: $product['Category'],
|
||||
provider_url: $product['ProductDetailUrl'],
|
||||
manufacturing_status: $this->releaseStatusCodeToManufacturingStatus($product['LifecycleStatus'] ?? null),
|
||||
datasheets: $this->parseDataSheets($product['DataSheetUrl'], $product['MouserPartNumber'] ?? null),
|
||||
vendor_infos: $this->pricingToDTOs($product['PriceBreaks'] ?? [], $product['MouserPartNumber'], $product['ProductDetailUrl']),
|
||||
);
|
||||
}
|
||||
return $result;
|
||||
|
||||
}
|
||||
|
||||
|
||||
private function generateProductURL($sku): string
|
||||
{
|
||||
return 'https://' . $this->store_id . '/' . $sku;
|
||||
}
|
||||
|
||||
|
||||
private function parseDataSheets(string $sheetUrl, string $sheetName): ?array
|
||||
{
|
||||
if ($sheetUrl === null) {
|
||||
return null;
|
||||
}
|
||||
$result = [];
|
||||
$result[] = new FileDTO(url: $sheetUrl, name: $sheetName);
|
||||
return $result;
|
||||
}
|
||||
|
||||
/*
|
||||
* Mouser API price is a string in the form "n[.,]nnn[.,] currency"
|
||||
* then this convert it to a number
|
||||
*/
|
||||
private function floatvalue($val){
|
||||
$val = str_replace(",",".",$val);
|
||||
$val = preg_replace('/\.(?=.*\.)/', '', $val);
|
||||
return floatval($val);
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts the pricing (StandardPricing field) from the Mouser API to an array of PurchaseInfoDTOs
|
||||
* @param array $price_breaks
|
||||
* @param string $order_number
|
||||
* @param string $product_url
|
||||
* @return PurchaseInfoDTO[]
|
||||
*/
|
||||
private function pricingToDTOs(array $price_breaks, string $order_number, string $product_url): array
|
||||
{
|
||||
$prices = [];
|
||||
|
||||
foreach ($price_breaks as $price_break) {
|
||||
$number = $this->floatvalue($price_break['Price']);
|
||||
$prices[] = new PriceDTO(minimum_discount_amount: $price_break['Quantity'], price: (string)$number, currency_iso_code: $price_break['Currency']);
|
||||
$number = 0;
|
||||
}
|
||||
|
||||
return [
|
||||
new PurchaseInfoDTO(distributor_name: self::DISTRIBUTOR_NAME, order_number: $order_number, prices: $prices, product_url: $product_url)
|
||||
];
|
||||
}
|
||||
|
||||
|
||||
|
||||
/* Converts the product status from the MOUSER API to the manufacturing status used in Part-DB:
|
||||
Factory Special Order - Ordine speciale in fabbrica
|
||||
Not Recommended for New Designs - Non raccomandato per nuovi progetti
|
||||
New Product - Nuovo prodotto
|
||||
End of Life - Fine vita
|
||||
-vuoto- - Attivo
|
||||
|
||||
TODO: Probably need to review the values of field Lifecyclestatus
|
||||
*/
|
||||
private function releaseStatusCodeToManufacturingStatus(?string $productStatus): ?ManufacturingStatus
|
||||
{
|
||||
return match ($productStatus) {
|
||||
null => null,
|
||||
"New Product" => ManufacturingStatus::ANNOUNCED,
|
||||
"Not Recommended for New Designs" => ManufacturingStatus::NRFND,
|
||||
"Factory Special Order" => ManufacturingStatus::DISCONTINUED,
|
||||
"End of Life" => ManufacturingStatus::EOL,
|
||||
"Obsolete" => ManufacturingStatus::DISCONTINUED,
|
||||
default => ManufacturingStatus::ACTIVE,
|
||||
};
|
||||
}
|
||||
|
||||
public function searchByKeyword(string $keyword): array
|
||||
{
|
||||
return $this->queryByTerm($keyword);
|
||||
}
|
||||
|
||||
public function getDetails(string $id): PartDetailDTO
|
||||
{
|
||||
$tmp = $this->queryPartNumber($id);
|
||||
|
||||
if (count($tmp) === 0) {
|
||||
throw new \RuntimeException('No part found with ID ' . $id);
|
||||
}
|
||||
|
||||
if (count($tmp) > 1) {
|
||||
throw new \RuntimeException('Multiple parts found with ID ' . $id);
|
||||
}
|
||||
|
||||
return $tmp[0];
|
||||
}
|
||||
|
||||
public function getCapabilities(): array
|
||||
{
|
||||
return [
|
||||
ProviderCapabilities::BASIC,
|
||||
ProviderCapabilities::PICTURE,
|
||||
ProviderCapabilities::DATASHEET,
|
||||
ProviderCapabilities::PRICE,
|
||||
];
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue