Add keyword search

mouser/api.py

@@ -88,15 +88,15 @@ class MouserPartSearchRequest(MouserBaseRequest):
 
     name = 'Part Search'
     operations = {
-        'keyword': ('', ''),
+        'keyword': ('POST', '/search/keyword'),
         'keywordandmanufacturer': ('', ''),
         'partnumber': ('POST', '/search/partnumber'),
         'partnumberandmanufacturer': ('', ''),
         'manufacturerlist': ('', ''),
     }
 
     def get_clean_response(self):
-        cleaned_data = {
+        cleaned_part_data = {
             'Availability': '',
             'Category': '',
             'DataSheetUrl': '',
@@ -118,13 +118,27 @@ def get_clean_response(self):
                 parts = None
 
             if parts:
-                # Process first part
-                part_data = parts[0]
-                # Merge
-                for key in cleaned_data:
-                    cleaned_data[key] = part_data.get(key, None)
-
-        return cleaned_data
+                cleaned_data = []
+
+                if self.operation == 'partnumber':
+                    # Process first part
+                    first_part = parts[0]
+                    # Merge
+                    cleaned_part = {}
+                    for key in cleaned_part_data:
+                        cleaned_part[key] = first_part.get(key, None)
+                    cleaned_data.append(cleaned_part)
+
+                if self.operation == 'keyword':
+
+                    # Process all parts
+                    for part in parts:
+                        cleaned_part = {}
+                        for key in cleaned_part_data:
+                            cleaned_part[key] = part.get(key, None)
+                        cleaned_data.append(cleaned_part)
+
+                return cleaned_data
 
     def print_clean_response(self):
         response_data = self.get_clean_response()
@@ -145,6 +159,21 @@ def get_body(self, **kwargs):
                         'partSearchOptions': option,
                     }
                 }
+        if self.operation == 'keyword':
+            keyword = kwargs.get('keyword', None)
+            record_limit = kwargs.get('record_limit', None)
+            option = kwargs.get('option', 'None')
+
+            if keyword:
+                body = {
+                    'SearchByKeywordRequest': {
+                        "keyword": keyword,
+                        "records": record_limit,
+                        "startingRecord": 0,
+                        "searchOptions": option,
+                        "searchWithYourSignUpLanguage": "en",
+                    }
+                }
 
         return body
 
@@ -162,3 +191,19 @@ def part_search(self, part_number, option='None'):
             return self.run(self.body)
         else:
             return False
+
+    def keyword_search(self, keyword, record_limit=0, option='None'):
+        '''Mouser Keyword Search'''
+
+        kwargs = {
+            'keyword': keyword,
+            'record_limit': record_limit,
+            'option': option,
+        }
+
+        self.body = self.get_body(**kwargs)
+
+        if self.api_key:
+            return self.run(self.body)
+        else:
+            return False

mouser/cli.py

@@ -15,8 +15,11 @@
 @click.argument('request_type', type=click.Choice(['cart', 'history', 'order', 'search'], case_sensitive=False), required=True)
 @click.argument('operation', required=True)
 @click.option('--number', required=False, help='Part or Order number.')
+@click.option('--keyword', required=False, help='Keyword(s) to search')
+@click.option('--record-limit', required=False, help='How many records --keyword search should return')
+@click.option('--option', required=False, help='Options supported by Mouser search engine. Available options depend on OPERATION.')
 @click.option('--export', is_flag=True, required=False, help='Export data to CSV.')
-def mouser_cli(request_type, operation, number, export):
+def mouser_cli(request_type, operation, number, keyword, record_limit, option, export):
     ''' Main CLI entry point '''
 
     args = []
@@ -50,15 +53,35 @@ def mouser_cli(request_type, operation, number, export):
                 if not number:
                     print('[ERROR]\tMissing Mouser Part Number')
                 else:
-                    # Run request
-                    search = request.part_search(number)
-                    # Print body
-                    print('[BODY]')
-                    print(json.dumps(request.body, indent=4, sort_keys=True))
-                    if search:
-                        # Print result
-                        print('[DATA]')
-                        request.print_clean_response()
+                    if option not in [None, 'None', 'Exact']:
+                        print('[ERROR]\t --option must be [None|Exact]')
+                    else:
+                        # Run request
+                        search = request.part_search(number, option)
+                        # Print body
+                        print('[BODY]')
+                        print(json.dumps(request.body, indent=4, sort_keys=True))
+                        if search:
+                            # Print result
+                            print('[DATA]')
+                            request.print_clean_response()
+
+            if operation == 'keyword':
+                if not keyword:
+                    print('[ERROR]\t Missing --keyword flag and keyword(s)')
+                else:
+                    if option not in [None, 'None', 'Rohs', 'InStock', 'RohsAndInStock']:
+                        print('[ERROR]\t --option must be [None|Rohs|InStock|RohsAndInStock]')
+                    else:
+                        # Run request
+                        search = request.keyword_search(keyword, record_limit, option)
+                        # Print body
+                        print('[BODY]')
+                        print(json.dumps(request.body, indent=4, sort_keys=True))
+                        if search:
+                            # Print result
+                            print('[DATA]')
+                            request.print_clean_response()
 
     elif request_type == 'cart':
         request = MouserCartRequest(operation, API_KEYS_FILE, *args)

run_tests.py

@@ -1,6 +1,7 @@
-from tests.test_mouser import test_version, test_search_partnumber
+from tests.test_mouser import test_version, test_search_partnumber, test_search_keyword
 
 
 if __name__ == '__main__':
     test_version()
     test_search_partnumber()
+    test_search_keyword()

tests/test_mouser.py

@@ -5,7 +5,6 @@
 def test_version():
     assert __version__ == '0.1.5'
 
-
 def test_search_partnumber(file_keys='mouser_api_keys.yaml'):
 
     partnumber = 'DMP2066LSN-7'
@@ -16,11 +15,27 @@ def test_search_partnumber(file_keys='mouser_api_keys.yaml'):
     success = request.part_search(partnumber)
     assert success is True
 
-    part = request.get_clean_response()
+    part = request.get_clean_response()[0]
+    assert part['Manufacturer'] == 'Diodes Incorporated'
+    assert part['ManufacturerPartNumber'] == 'DMP2066LSN-7'
+    assert part['MouserPartNumber'] == '621-DMP2066LSN-7'
+
+def test_search_keyword(file_keys='mouser_api_keys.yaml'):
+
+    keyword = 'DMP2066LSN-7'
+
+    request = MouserPartSearchRequest('keyword', file_keys=file_keys)
+    assert request.api_url == 'https://api.mouser.com/api/v1.0/search/keyword'
+
+    success = request.keyword_search(keyword)
+    assert success is True
+
+    part = request.get_clean_response()[0]
     assert part['Manufacturer'] == 'Diodes Incorporated'
     assert part['ManufacturerPartNumber'] == 'DMP2066LSN-7'
     assert part['MouserPartNumber'] == '621-DMP2066LSN-7'
 
 if __name__ == '__main__':
     test_version()
     test_search_partnumber()
+    test_search_keyword()