django-bom 1.262__py3-none-any.whl

bom/third_party_apis/base_api.py

@@ -0,0 +1,51 @@
+import json
+import requests
+import hashlib
+
+from django.conf import settings
+from django.core.cache import cache
+
+
+class BaseApi:
+    def __init__(self, api_settings_key, root_url, api_key_query=None, cache_timeout=86400):
+        self.api_key = None
+        self.root_url = root_url
+        self.api_key_query = api_key_query
+        self.cache_timeout = cache_timeout
+        try:
+            self.api_key = settings.BOM_CONFIG[api_settings_key]
+        except KeyError as e:
+            raise ValueError('No API key for {} found on server. Contact administrator for help.'.format(api_settings_key))
+
+    def request(self, suburl, data=None):
+        cache_key = suburl
+        if data is not None:
+            data_md5 = hashlib.md5(json.dumps(data, sort_keys=True).encode('utf-8')).hexdigest()
+            cache_key += '-{}'.format(data_md5)
+        cached_data = cache.get(cache_key)
+        if cached_data is not None:
+            # print('Found cached data!')
+            return cached_data
+
+        url = self.root_url + suburl
+
+        if self.api_key_query is None or self.api_key is None:
+            raise ValueError('No API key, or api key query found on server. Contact administrator for help.')
+
+        params = ((self.api_key_query, self.api_key), )
+        headers = {'accept': 'application/json', }
+
+        if data is not None:
+            headers.update({'Content-Type': 'application/json'})
+            r = requests.post(url, headers=headers, params=params, data=json.dumps(data))
+        else:
+            r = requests.get(url, headers=headers, params=params)
+        if r.status_code != 200:
+            raise BaseApiError(f"HTTP Response != 200. Returned: {r.status_code} {r.reason}")
+
+        cache.set(cache_key, r.content, self.cache_timeout)
+        return r.content
+
+
+class BaseApiError(Exception):
+    pass

bom/third_party_apis/google_drive.py

@@ -0,0 +1,166 @@
+from django.contrib import messages
+from django.contrib.auth.decorators import login_required
+from django.core.exceptions import ObjectDoesNotExist
+from django.http import HttpResponseRedirect
+from django.urls import reverse
+
+from google.oauth2.credentials import Credentials
+from googleapiclient.discovery import build
+from googleapiclient.errors import HttpError
+from requests import HTTPError
+from social_django.utils import load_strategy
+
+from bom.decorators import google_authenticated
+from bom.models import Part
+
+
+# Helpers
+def get_service(user):
+    social = user.social_auth.get(provider='google-oauth2')
+    ls = load_strategy()
+    access_token = social.get_access_token(ls)
+    credentials = Credentials(access_token)
+    service = build('drive', 'v3', credentials=credentials)
+    return service
+
+
+def create_root(user):
+    organization = user.bom_profile().organization
+    service = get_service(user)
+    file_metadata = {
+        'name': 'IndaBOM Part Files',
+        'mimeType': 'application/vnd.google-apps.folder',
+        'folderColorRgb': 'green',
+    }
+    file = service.files().create(body=file_metadata, fields='id').execute()
+    organization.google_drive_parent = file.get('id')
+    organization.save()
+    return organization.google_drive_parent
+
+
+def create_part_folder(user, part):
+    service = get_service(user)
+    print("got service")
+    organization = user.bom_profile().organization
+    file_metadata = {
+        'name': part.full_part_number() + ' ' + part.latest().description,
+        'mimeType': 'application/vnd.google-apps.folder',
+        'parents': [organization.google_drive_parent],
+    }
+    print("about to create")
+    file = service.files().create(body=file_metadata, fields='id').execute()
+    part.google_drive_parent = file.get('id')
+    part.save()
+    return part.google_drive_parent
+
+
+def get_files_list(user, part):
+    # TODO: Figure this out...
+    service = get_service(user)
+    response = service.files().list(q="'{}' in parents".format(part.google_drive_parent),
+                                    fields='files(id, name)').execute()
+    return response
+
+
+# Social Auth Pipeline
+def initialize_parent(backend, user, response, *args, **kwargs):
+    if backend.name == 'google-oauth2':
+        # Only the owner can create the root folder
+        if user.bom_profile().organization.owner is user:
+            create_root(user)
+
+
+def uninitialize_parent(backend, user, *args, **kwargs):
+    if backend.name == 'google-oauth2':
+        organization = user.bom_profile().organization
+        # Do nothing for now, let's not deactivate the folder, maybe the user wants it back later,
+        # Let's instead run a try/catch when we get the parent folder given the stored ID, if there's an error, we create
+        # Only the owner can create the root folder
+        # if user.bom_profile().organization.owner is user:
+        # service = get_service(user)
+        # file = service.files().get(fileId=organization.google_drive_parent).execute()
+        # inactive_filename = file['name'] + '(inactive {})'.format(datetime.now())
+        # service.files().update(fileId=organization.google_drive_parent, body={'name': inactive_filename}).execute()
+
+
+# Views
+@login_required
+@google_authenticated
+def get_or_create_and_open_folder(request, part_id):
+    user = request.user
+    organization = user.bom_profile().organization
+    try:
+        service = get_service(user)
+    except HTTPError as e:
+        return HttpResponseRedirect(reverse('social:begin', kwargs={'backend': "google-oauth2"}))
+
+    if not organization.google_drive_parent:
+        if user == organization.owner:
+            create_root(user)
+        else:
+            messages.error(request,
+                           "There's no root Google Drive directory and you're not the owner. Contact your organization owner to set up Google Drive")
+    else:
+        if user == organization.owner:
+            try:
+                service.files().get(fileId=organization.google_drive_parent).execute()
+            except HttpError:
+                create_root(user)
+
+    try:
+        part = Part.objects.get(id=part_id)
+    except ObjectDoesNotExist:
+        messages.error(request, "Part object does not exist.")
+        return HttpResponseRedirect(request.META.get('HTTP_REFERER', '/'))
+
+    if part.google_drive_parent:
+        try:
+            service.files().get(fileId=part.google_drive_parent).execute()
+        except HttpError:
+            if user == organization.owner:
+                # if they aren't the owner, let's just try to go to the folder...
+                try:
+                    create_part_folder(user, part)
+                except HttpError as e:
+                    messages.error(request, "Error: {}".format(e))
+                    return HttpResponseRedirect(request.META.get('HTTP_REFERER', '/'))
+    # TODO: Check if the folder name exists already before creating it ?
+    else:
+        try:
+            create_part_folder(user, part)
+        except HttpError as e:
+            for detail in e.error_details:
+                msg = detail['message'] if 'message' in detail else 'Unknown error'
+                if 'reason' in detail and detail['reason'] == 'notFound':
+                    msg += '<br>You may need to ask your organization owner to share the organization folder with you.'
+                messages.error(request, "Error: {}".format(msg))
+
+            return HttpResponseRedirect(request.META.get('HTTP_REFERER', '/'))
+
+    return HttpResponseRedirect('https://drive.google.com/drive/folders/{}'.format(part.google_drive_parent))
+
+
+@login_required
+@google_authenticated
+def update_folder_name(request, part_id):
+    user = request.user
+    organization = user.bom_profile().organization
+    try:
+        service = get_service(user)
+    except HTTPError as e:
+        return HttpResponseRedirect(reverse('social:begin', kwargs={'backend': "google-oauth2"}))
+
+    if not organization.google_drive_parent:
+        create_root(user)
+
+    try:
+        part = Part.objects.get(id=part_id)
+    except ObjectDoesNotExist:
+        messages.error(request, "Part object does not exist.")
+        return HttpResponseRedirect(request.META.get('HTTP_REFERER', '/'))
+
+    if part.google_drive_parent:
+        new_filename = part.full_part_number() + ' ' + part.latest().description
+        service.files().update(fileId=part.google_drive_parent, body={'name': new_filename}).execute()
+    # TODO: Finish this... should update filename on
+    return

bom/third_party_apis/mouser.py

@@ -0,0 +1,132 @@
+from moneyed import Money
+
+from bom.utils import parse_number
+from djmoney.contrib.exchange.models import convert_money
+from .base_api import BaseApi, BaseApiError
+from ..models import SellerPart, Seller
+import json
+
+
+class MouserApi(BaseApi):
+    def __init__(self, *args, **kwargs):
+        api_settings_key = 'mouser_api_key'
+        root_url='https://api.mouser.com/api/v1'
+        api_key_query = 'apiKey'
+        super().__init__(api_settings_key, root_url, api_key_query=api_key_query)
+
+    @staticmethod
+    def parse_and_check_for_errors(content):
+        data = json.loads(content)
+        errors = data['Errors']
+        if len(errors) > 0:
+            raise BaseApiError("Error(s): {}".format(errors))
+        return data
+
+    def search_keyword(self, keyword):
+        content = self.request('/search/keyword', data={
+            "SearchByKeywordRequest": {
+                "keyword": keyword,
+                "records": 0,
+                "startingRecord": 0,
+                "searchOptions": "",
+                "searchWithYourSignUpLanguage": ""
+            }
+        })
+        data = self.parse_and_check_for_errors(content)
+        return data["SearchResults"]
+
+    def get_manufacturer_list(self):
+        content = self.request('/search/manufacturerlist')
+        data = self.parse_and_check_for_errors(content)
+        return data["MouserManufacturerList"]
+
+    def search_part(self, part_number):
+        content = self.request('/search/partnumber', data={
+            "SearchByPartRequest": {
+                "mouserPartNumber": part_number,
+                "partSearchOptions": "",
+            }
+        })
+        data = self.parse_and_check_for_errors(content)
+        return data["SearchResults"]
+
+    def search_part_and_manufacturer(self, part_number, manufacturer_id):
+        content = self.request('/search/partnumberandmanufacturer', data={
+            "SearchByPartMfrRequest": {
+                "manufacturerId": manufacturer_id,
+                "mouserPartNumber": part_number,
+                "partSearchOptions": "",
+            }
+        })
+        data = self.parse_and_check_for_errors(content)
+        return data["SearchResults"]
+
+
+class Mouser:
+    def __init__(self):
+        self.api = MouserApi()
+
+    def search_and_match(self, manufacturer_part, quantity=1, currency=None):
+        manufacturer = manufacturer_part.manufacturer
+        manufacturer_part_number = manufacturer_part.manufacturer_part_number
+        if manufacturer:
+            manufacturer_list = self.api.get_manufacturer_list()
+            # TODO: possibly get manufacturer id from manufacturer list, do a fuzzy lookup using manufacturer name
+            #  to reduce results
+            mfg_id = manufacturer_list[manufacturer.name] if manufacturer.name in manufacturer_list else None
+            if mfg_id:
+                results = self.api.search_part_and_manufacturer(part_number=manufacturer_part_number, manufacturer_id=mfg_id)
+            else:
+                results = self.api.search_part(part_number=manufacturer_part_number)
+        else:
+            results = self.api.search_part(part_number=manufacturer_part_number)
+
+        mouser_parts = []
+        optimal_part = None
+        seller_parts = []
+        for part in results['Parts']:
+            seller = Seller(name='Mouser')
+            try:
+                quantity_available = [int(s) for s in part['Availability'].split() if s.isdigit()][0]
+                mouser_part = {
+                    'part_number': part['ManufacturerPartNumber'],
+                    'manufacturer': part['Manufacturer'],
+                    'description': part['Description'],
+                    'data_sheet': part['DataSheetUrl'],
+                    'stock': part['Availability'],
+                    'stock_parsed': quantity_available,
+                    'lead_time': part['LeadTime'],
+                    'seller_parts': [],
+                    'product_detail_url': part['ProductDetailUrl'],
+                }
+
+                lead_time_days = [int(s) for s in part['LeadTime'].split() if s.isdigit()][0]  # TODO: Make sure it's actually days
+                for pb in part['PriceBreaks']:
+                    moq = int(pb['Quantity'])
+                    unit_price_raw = parse_number(pb['Price'])
+                    unit_currency = pb['Currency']
+                    unit_cost = Money(unit_price_raw, unit_currency)
+                    if currency:
+                        unit_cost = convert_money(unit_cost, currency)
+                    seller_part = SellerPart(
+                        seller=seller,
+                        seller_part_number=part['MouserPartNumber'],
+                        manufacturer_part=manufacturer_part,
+                        minimum_order_quantity=moq,
+                        minimum_pack_quantity=1,
+                        data_source='Mouser',
+                        unit_cost=unit_cost,
+                        lead_time_days=lead_time_days,
+                        nre_cost=Money(0, currency),
+                        ncnr=True)
+                    mouser_part['seller_parts'].append(seller_part.as_dict())
+                    seller_parts.append(seller_part)
+                mouser_parts.append(mouser_part)
+            except (KeyError, AttributeError, IndexError):
+                continue
+        local_seller_parts = list(manufacturer_part.seller_parts())
+        seller_parts.extend(local_seller_parts)
+        return {
+            'mouser_parts': mouser_parts,
+            'optimal_seller_part': SellerPart.optimal(seller_parts, quantity),
+        }

bom/third_party_apis/test_apis.py

@@ -0,0 +1,24 @@
+from django.test import TestCase
+from .mouser import MouserApi
+from unittest import skip
+
+
+class TestMouser(TestCase):
+    def setUp(self):
+        self.api = MouserApi()
+
+    @skip
+    def test_search_keyword(self):
+        search = self.api.search_keyword(keyword='LSM6DSL')
+        self.assertGreaterEqual(search['NumberOfResult'], 1)
+
+    @skip
+    def test_get_manufacturer_list(self):
+        manufacturers = self.api.get_manufacturer_list()
+        self.assertGreaterEqual(manufacturers['Count'], 1)
+
+    @skip
+    def search_part_and_manufacturer(self):
+        manufacturers = self.api.get_manufacturer_list()
+        self.assertGreaterEqual(manufacturers['Count'], 1)
+

bom/urls.py

@@ -0,0 +1,100 @@
+from django.conf import settings
+from django.contrib import admin
+from django.contrib.auth import views as auth_views
+from django.urls import include, path
+from django.views.generic import TemplateView
+
+from bom.third_party_apis import google_drive
+from bom.views import json_views, views
+
+BOM_CONFIG = getattr(settings, 'BOM_CONFIG', {})
+standalone_mode = BOM_CONFIG.get('standalone_mode', True)
+
+bom_patterns = [
+    # BOM urls
+    path('', views.home, name='home'),
+    # path('bom/', views.home, name='home'),
+    path('create-organization/', views.organization_create, name='organization-create'),
+    path('help/', views.Help.as_view(), name=views.Help.name),
+    path('search-help/', views.search_help, name='search-help'),
+    path('bom-signup/', views.bom_signup, name='bom-signup'),
+    path('settings/', views.bom_settings, name='settings'),
+    path('settings/<str:tab_anchor>/', views.bom_settings, name='settings'),
+    path('manufacturers/', views.manufacturers, name='manufacturers'),
+    path('manufacturer/<int:manufacturer_id>/', views.manufacturer_info, name='manufacturer-info'),
+    path('manufacturer/<int:manufacturer_id>/edit/', views.manufacturer_edit, name='manufacturer-edit'),
+    path('manufacturer/<int:manufacturer_id>/delete/', views.manufacturer_delete, name='manufacturer-delete'),
+    path('sellers/', views.sellers, name='sellers'),
+    path('seller/<int:seller_id>/', views.seller_info, name='seller-info'),
+    path('seller/<int:seller_id>/edit/', views.seller_edit, name='seller-edit'),
+    path('seller/<int:seller_id>/delete/', views.seller_delete, name='seller-delete'),
+    path('export/', views.export_part_list, name='export-part-list'),
+    path('user-meta/<int:user_meta_id>/edit/', views.user_meta_edit, name='user-meta-edit'),
+    path('part-class/<int:part_class_id>/edit/', views.part_class_edit, name='part-class-edit'),
+    path('property-definition/add/', views.property_definition_edit, name='property-definition-add'),
+    path('property-definition/<int:property_definition_id>/edit/', views.property_definition_edit, name='property-definition-edit'),
+    path('property-definition/<int:property_definition_id>/delete/', views.property_definition_delete, name='property-definition-delete'),
+    path('quantity-of-measure/add/', views.quantity_of_measure_edit, name='quantity-of-measure-add'),
+    path('quantity-of-measure/<int:quantity_of_measure_id>/edit/', views.quantity_of_measure_edit, name='quantity-of-measure-edit'),
+    path('quantity-of-measure/<int:quantity_of_measure_id>/delete/', views.quantity_of_measure_delete, name='quantity-of-measure-delete'),
+    path('create-part/', views.create_part, name='create-part'),
+    path('upload-parts/', views.upload_parts, name='upload-parts'),
+    path('upload-parts-help/', views.upload_parts_help, name='upload-parts-help'),
+    path('upload-bom/', views.upload_bom, name='upload-bom'),
+    path('part/<int:part_id>/', views.part_info, name='part-info'),
+    path('part/<int:part_id>/export/', views.part_export_bom, name='part-export-bom'),
+    path('part/<int:part_id>/export-sourcing/', views.part_export_bom, name='part-export-bom-sourcing', kwargs={'sourcing': True}),
+    path('part/<int:part_id>/export-sourcing-detailed/', views.part_export_bom, name='part-export-bom-sourcing-detailed', kwargs={'sourcing_detailed': True}),
+    path('part/<int:part_id>/upload/', views.part_upload_bom, name='part-upload-bom'),
+    path('part/<int:part_id>/edit/', views.part_edit, name='part-edit'),
+    path('part/<int:part_id>/delete/', views.part_delete, name='part-delete'),
+    path('part/<int:part_id>/add-manufacturer-part/', views.add_manufacturer_part, name='part-add-manufacturer-part'),
+    path('part/<int:part_id>/rev/new/', views.part_revision_new, name='part-revision-new'),
+    path('part/<int:part_id>/rev/<int:part_revision_id>/', views.part_info, name='part-info-history'),
+    path('part/<int:part_id>/rev/<int:part_revision_id>/edit/', views.part_revision_edit, name='part-revision-edit'),
+    path('part/<int:part_id>/rev/<int:part_revision_id>/delete/', views.part_revision_delete, name='part-revision-delete'),
+    path('part/<int:part_id>/rev/<int:part_revision_id>/release/', views.part_revision_release, name='part-revision-release'),
+    path('part/<int:part_id>/rev/<int:part_revision_id>/revert/', views.part_revision_revert, name='part-revision-revert'),
+    path('part/<int:part_id>/rev/<int:part_revision_id>/remove-all-subparts/', views.remove_all_subparts, name='part-remove-all-subparts'),
+    path('part/<int:part_id>/rev/<int:part_revision_id>/edit-subpart/<int:subpart_id>', views.edit_subpart, name='part-edit-subpart'),
+    path('part/<int:part_id>/rev/<int:part_revision_id>/remove-subpart/<int:subpart_id>/', views.remove_subpart, name='part-remove-subpart'),
+    path('part/<int:part_id>/rev/<int:part_revision_id>/manage-bom/', views.manage_bom, name='part-manage-bom'),
+    path('part/<int:part_id>/rev/<int:part_revision_id>/add-subpart/', views.add_subpart, name='part-add-subpart'),
+
+    path('part-rev/<int:part_revision_id>/export/', views.part_export_bom, name='part-revision-export-bom'),
+    path('part-rev/<int:part_revision_id>/export-sourcing/', views.part_export_bom, name='part-revision-export-bom-sourcing', kwargs={'sourcing': True}),
+    path('part-rev/<int:part_revision_id>/export-sourcing-detailed/', views.part_export_bom, name='part-revision-export-bom-sourcing-detailed', kwargs={'sourcing_detailed': True}),
+    path('part-rev/<int:part_revision_id>/export-flat/', views.part_export_bom, name='part-revision-export-bom-flat', kwargs={'flat': True}),
+    path('part-rev/<int:part_revision_id>/export-flat-sourcing/', views.part_export_bom, name='part-revision-export-bom-flat-sourcing', kwargs={'flat': True, 'sourcing': True}),
+    path('part-rev/<int:part_revision_id>/export-flat-sourcing-detailed/', views.part_export_bom, name='part-revision-export-bom-flat-sourcing-detailed', kwargs={'flat': True, 'sourcing_detailed': True}),
+
+    path('sellerpart/<int:sellerpart_id>/edit/', views.sellerpart_edit, name='sellerpart-edit'),
+    path('sellerpart/<int:sellerpart_id>/delete/', views.sellerpart_delete, name='sellerpart-delete'),
+    path('manufacturer-part/<int:manufacturer_part_id>/add-sellerpart/', views.add_sellerpart, name='manufacturer-part-add-sellerpart'),
+    path('manufacturer-part/<int:manufacturer_part_id>/edit', views.manufacturer_part_edit, name='manufacturer-part-edit'),
+    path('manufacturer-part/<int:manufacturer_part_id>/delete', views.manufacturer_part_delete, name='manufacturer-part-delete'),
+]
+
+google_drive_patterns = [
+    path('folder/<int:part_id>/', google_drive.get_or_create_and_open_folder, name='add-folder'),
+]
+
+json_patterns = [
+    path('mouser-part-match-bom/<int:part_revision_id>/', json_views.MouserPartMatchBOM.as_view(), name='mouser-part-match-bom')
+]
+
+urlpatterns = [
+    path('', include((bom_patterns, 'bom'))),
+    path('', include('social_django.urls', namespace='social')),
+    path('google-drive/', include((google_drive_patterns, 'google-drive'))),
+    path('json/', include((json_patterns, 'json'))),
+]
+
+if standalone_mode:
+    urlpatterns += [
+        path('admin/', admin.site.urls),
+        path('signup/', views.signup, name='signup'),
+        path('login/', auth_views.LoginView.as_view(redirect_authenticated_user=True), name='login'),
+        path('logout/', auth_views.LogoutView.as_view(next_page='/'), name='logout'),
+        path('account/delete/', TemplateView.as_view(template_name='bom/account-delete.html'), name='account-delete'),
+    ]