Merge pull request #27 from sergioteula/dev_browsenode

Added browse node functionality, removed 10 pages limit and solved unnecessary API call

Author: sergioteula

README.md

@@ -15,6 +15,7 @@ Features
 * Object oriented interface for simple usage.
 * Get information about a product through its ASIN or URL.
 * Get item variations or search for products on Amazon.
+* Get browse nodes information.
 * Get multiple results at once without the 10 items limitation from Amazon.
 * Configurable throttling to avoid requests exceptions.
 * Support for [all available countries](https://github.com/sergioteula/python-amazon-paapi/blob/master/amazon/paapi.py#L31).
@@ -58,6 +59,10 @@ Usage guide
     product = amazon.search_products(item_count=25, keywords='speaker')
     print(product[14].url)
 
+**Get browse node information:**
+
+    node = amazon.get_browsenodes(browse_nodes=browsenodes_list)
+
 **Get the ASIN from a URL:**
 
     from amazon.tools import get_asin
@@ -72,6 +77,11 @@ Throttling value must be `greater than 0` or `False` to disable it. This value t
 
 Changelog
 -------------
+    Version 3.2.0
+        - Added new method for getting browse nodes information.
+        - Removed the 10 pages limit on search_products and get_variations methods.
+        - Solved unnecessary API call on search_products and get_variations methods.
+
     Version 3.1.0
         - Added paapi5-python-sdk and removed amightygirl.paapi5-python-sdk.
         - Improved throttling and now possible to disable it.

amazon/__init__.py

@@ -1,4 +1,4 @@
 """Amazon Product Advertising API wrapper for Python"""
 
-__version__ = '3.1.0'
+__version__ = '3.2.0'
 __author__ = 'Sergio Abad'

amazon/constant.py

@@ -3,6 +3,7 @@
 from paapi5_python_sdk.get_items_resource import GetItemsResource
 from paapi5_python_sdk.search_items_resource import SearchItemsResource
 from paapi5_python_sdk.get_variations_resource import GetVariationsResource
+from paapi5_python_sdk.get_browse_nodes_resource import GetBrowseNodesResource
 from paapi5_python_sdk.condition import Condition
 
 """Available regions for the Amazon API."""
@@ -228,3 +229,9 @@
     GetVariationsResource.VARIATIONSUMMARY_PRICE_LOWESTPRICE,
     GetVariationsResource.VARIATIONSUMMARY_VARIATIONDIMENSION
 ]
+
+"""Browse Node resources to get from Amazon API."""
+BROWSE_RESOURCES = [
+    GetBrowseNodesResource.ANCESTOR,
+    GetBrowseNodesResource.CHILDREN
+]

amazon/paapi.py

@@ -9,13 +9,15 @@
 from paapi5_python_sdk.get_items_request import GetItemsRequest
 from paapi5_python_sdk.search_items_request import SearchItemsRequest
 from paapi5_python_sdk.get_variations_request import GetVariationsRequest
+from paapi5_python_sdk.get_browse_nodes_request import GetBrowseNodesRequest
 from paapi5_python_sdk.partner_type import PartnerType
 from paapi5_python_sdk.rest import ApiException
 
 from amazon.constant import DOMAINS, REGIONS, CONDITION
 from amazon.constant import PRODUCT_RESOURCES, SEARCH_RESOURCES, VARIATION_RESOURCES
+from amazon.constant import BROWSE_RESOURCES
 from amazon.exception import AmazonException
-from amazon.parse import parse_product
+from amazon.parse import parse_product, AmazonBrowseNode, parse_browsenode
 from amazon.tools import get_asin, chunks
 
 import time
@@ -226,8 +228,8 @@ def search_products(self, item_count=10, item_page=1, items_per_page=10, keyword
             raise AmazonException('ValueError', 'Arg items_per_page should be between 1 and 10')
         if item_count > 100 or item_count < 1:
             raise AmazonException('ValueError', 'Arg item_count should be between 1 and 100')
-        if item_page > 10 or item_page < 1:
-            raise AmazonException('ValueError', 'Arg item_page should be between 1 and 10')
+        if item_page < 1:
+            raise AmazonException('ValueError', 'Arg item_page should be 1 or higher')
         if not keywords and not actor and not artist and not author and not brand and not title:
             raise AmazonException('ValueError', 'At least one of the following args must be '
                                                 'provided: keywords, actor, artist, author, brand,'
@@ -284,6 +286,8 @@ def search_products(self, item_count=10, item_page=1, items_per_page=10, keyword
                             results.append(parse_product(item))
                             if len(results) >= item_count:
                                 break
+                        if len(response.search_result.items) < items_per_page:
+                            break
                 else:
                     break
                 if response.errors is not None:
@@ -293,8 +297,6 @@ def search_products(self, item_count=10, item_page=1, items_per_page=10, keyword
                     break
                 raise AmazonException('ResponseError', e)
             item_page += 1
-            if item_page > 10:
-                break
 
         if results:
             return results
@@ -331,8 +333,8 @@ def get_variations(self, asin, item_count=10, item_page=1, items_per_page=10, co
             raise AmazonException('ValueError', 'Arg items_per_page should be between 1 and 10')
         if item_count > 100 or item_count < 1:
             raise AmazonException('ValueError', 'Arg item_count should be between 1 and 100')
-        if item_page > 10 or item_page < 1:
-            raise AmazonException('ValueError', 'Arg item_page should be between 1 and 10')
+        if item_page < 1:
+            raise AmazonException('ValueError', 'Arg item_page should be 1 or higher')
 
         results = []
         while len(results) < item_count:
@@ -373,17 +375,70 @@ def get_variations(self, asin, item_count=10, item_page=1, items_per_page=10, co
                             results.append(parse_product(item))
                             if len(results) >= item_count:
                                 break
+                        if len(response.variations_result.items) < items_per_page:
+                            break
                 else:
                     break
                 if response.errors is not None:
                     raise AmazonException(response.errors[0].code, response.errors[0].message)
             except Exception as e:
                 raise AmazonException('ResponseError', e)
             item_page += 1
-            if item_page > 10:
-                break
 
         if results:
             return results
         else:
             return None
+
+    def get_browsenodes(self, browse_nodes, async_req=False):
+        """Get browse nodes information from Amazon.
+
+        Args:
+            browse_nodes (list): List of strings containing the browse node ids.
+            async_req (bool, optional): Specify if a thread should be created to
+                run the request. Defaults to False.
+
+        Returns:
+            dict: A dictionary containing the browse node information.
+        """
+
+        if isinstance(browse_nodes, list) is False:
+            raise Exception('Browse nodes parameter should be a list')
+        elif not browse_nodes:
+            raise Exception('Browse nodes parameter can\'t be empty')
+
+        try:
+            request = GetBrowseNodesRequest(
+                partner_tag=self.tag,
+                partner_type=PartnerType.ASSOCIATES,
+                marketplace=self.marketplace,
+                browse_node_ids=browse_nodes,
+                languages_of_preference=None,
+                resources=BROWSE_RESOURCES)
+        except ValueError as e:
+            raise AmazonException("ValueError", e)
+
+        try:
+            self._throttle()
+            if async_req:
+                thread = self.api.get_browse_nodes(request, async_req=True)
+                response = thread.get()
+            else:
+                response = self.api.get_browse_nodes(request)
+        except ApiException as e:
+            raise AmazonException('ApiException', e)
+
+        try:
+            if response.browse_nodes_result is not None:
+                res = [AmazonBrowseNode(item) for item in response.browse_nodes_result.browse_nodes]
+                return parse_browsenode(res)
+            if response.errors is not None:
+                raise AmazonException(response.errors[0].code, response.errors[0].message)
+        except TypeError as e:
+            raise AmazonException("TypeError", e)
+        except ValueError as e:
+            raise AmazonException(ValueError, e)
+        except AmazonException as e:
+            raise AmazonException(e.status, e.reason)
+        except Exception as e:
+            raise AmazonException("General", e)

amazon/parse.py

@@ -6,6 +6,83 @@ class Class:
     pass
 
 
+class AmazonBrowseNode():
+    swagger_types = {
+        'ancestor': 'BrowseNodeAncestor',
+        'children': 'BrowseNodeChildren',
+        'context_free_name': 'str',
+        'display_name': 'str',
+        'id': 'str',
+        'is_root': 'bool',
+        'sales_rank': 'int'
+    }
+
+    def __init__(self, node):
+        self.ancestor = node.ancestor
+        self.children = node.children
+        self.context_free_name = node.context_free_name
+        self.display_name = node.display_name
+        self.id = node.id
+        self.is_root = node.is_root
+        self.sales_rank = node.sales_rank
+
+    def to_dict(self):
+        result = {}
+
+        for attr, _ in six.iteritems(self.swagger_types):
+            value = getattr(self, attr)
+            if isinstance(value, list):
+                result[attr] = list(map(
+                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+                    value
+                ))
+            elif hasattr(value, "to_dict"):
+                result[attr] = value.to_dict()
+            elif isinstance(value, dict):
+                result[attr] = dict(map(
+                    lambda item: (item[0], item[1].to_dict())
+                    if hasattr(item[1], "to_dict") else item,
+                    value.items()
+                ))
+            else:
+                result[attr] = value
+        if issubclass(BrowseNode, dict):
+            for key, value in self.items():
+                result[key] = value
+
+        return result
+
+    def to_str(self):
+        return pprint.pformat(self.to_dict())
+
+    def __repr__(self):
+        return self.to_str()
+
+    def __eq__(self, other):
+        if not isinstance(other, BrowseNode):
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other
+
+
+def parse_browsenode(browse_nodes_response):
+    """Parse browse node data and creates a dict.
+
+    Args:
+        browse_nodes_response (list): List of browse nodes responses.
+
+    Returns:
+        dict: Dict with browse node information.
+    """
+    mapped_response = {}
+    for browse_node in browse_nodes_response:
+        mapped_response[browse_node.id] = browse_node
+    return mapped_response
+
+
 def parse_product(item):
     """Parse item data and creates product instance.
 

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name='python-amazon-paapi',
-    version='3.1.0',
+    version='3.2.0',
     author='Sergio Abad',
     author_email='sergio.abad@bytelix.com',
     description='Amazon Product Advertising API 5.0 wrapper for Python',