Finish subscriptions (incl. order, orderline, product)

Author: rerb

membersuite_api_client/financial/__init__.py

@@ -0,0 +1,18 @@
+from __future__ import (absolute_import, division, print_function,
+                        unicode_literals)
+from future.utils import python_2_unicode_compatible
+
+from ..models import MemberSuiteObject
+
+
+@python_2_unicode_compatible
+class Product(MemberSuiteObject):
+
+    def __init__(self, membersuite_object_data, session_id=None):
+        """Create an Product object from a the Zeep'ed XML
+        representation of a Membersuite Product.
+
+        """
+        super(Product, self).__init__(
+            membersuite_object_data=membersuite_object_data)
+        self.name = self.fields['Name']

membersuite_api_client/financial/models.py

@@ -0,0 +1,27 @@
+from ..exceptions import ExecuteMSQLError
+from ..utils import get_new_client
+from .models import Product
+
+
+def get_product(membersuite_id, client=None):
+    """Return a Product object by ID.
+    """
+    if not membersuite_id:
+        return None
+
+    client = client or get_new_client(request_session=True)
+
+    query = "SELECT Object() FROM PRODUCT WHERE ID = '{}'".format(
+        membersuite_id)
+
+    result = client.runSQL(query)
+
+    msql_result = result["body"]["ExecuteMSQLResult"]
+
+    if msql_result["Success"]:
+        membersuite_object_data = (msql_result["ResultValue"]
+                                   ["SingleObject"])
+    else:
+        raise ExecuteMSQLError(result=result)
+
+    return Product(membersuite_object_data=membersuite_object_data)

membersuite_api_client/financial/services.py

@@ -28,10 +28,6 @@ class ChunkQueryMixin(object):
 
     Membersuite will often time out on big queries, so this allows us to
     break it up into smaller requests.
-
-    Design assumptions:
-        - The service defines an `result_to_models` method to "transform"
-        the objects returned by the endpoint
     """
 
     def get_long_query(self, base_query, limit_to=100, max_calls=None,
@@ -86,7 +82,6 @@ def get_long_query(self, base_query, limit_to=100, max_calls=None,
             else:
                 search_results = None
 
-
             if search_results is None:
                 result_set = []
             else:

membersuite_api_client/mixins.py

@@ -8,16 +8,18 @@
 @python_2_unicode_compatible
 class MemberSuiteObject(object):
 
-    def __init__(self, membersuite_object_data):
+    def __init__(self, membersuite_object_data, membersuite_id=None):
         """Takes the Zeep'ed XML Representation of a MemberSuiteObject as
         input.
 
         """
         self.fields = convert_ms_object(
             membersuite_object_data["Fields"]["KeyValueOfstringanyType"])
-
-        self.membersuite_id = self.fields["ID"]
         self.extra_data = membersuite_object_data
+        self.membersuite_id = (self.fields["ID"]
+                               if membersuite_id is None
+                               else membersuite_id)
 
     def __str__(self):
-        return ("<MemberSuiteObject: ID: {id}>".format(id=self.id))
+        return ("<MemberSuiteObject: MemberSuite ID: {id}>".format(
+            id=self.membersuite_id))

membersuite_api_client/models.py

@@ -0,0 +1,86 @@
+from __future__ import (absolute_import, division, print_function,
+                        unicode_literals)
+from future.utils import python_2_unicode_compatible
+
+from ..models import MemberSuiteObject
+from ..utils import get_new_client, value_for_key
+from ..financial import services as financial_services
+
+
+@python_2_unicode_compatible
+class OrderLineItem(MemberSuiteObject):
+
+    def __init__(self, membersuite_object_data, session_id=None):
+        """Create an OrderLineItem object from a the Zeep'ed XML
+        representation of a Membersuite OrderLineItem.
+
+        """
+        membersuite_id = value_for_key(
+            membersuite_object_data=membersuite_object_data,
+            key="OrderLineItemID")
+        super(OrderLineItem, self).__init__(
+            membersuite_object_data=membersuite_object_data,
+            membersuite_id=membersuite_id)
+        self.product_id = self.fields["Product"]
+        self.session_id = session_id
+
+    def __str__(self):
+        return ("<Order: ID: {id}, product: {product} "
+                " session_id: {session_id}>".format(
+                    id=self.membersuite_id,
+                    product=self.product,
+                    session_id=self.session_id))
+
+    def get_product(self, client=None):
+        """Return a Product object for this line item.
+        """
+        client = client or get_new_client(request_session=True)
+        if not client.session_id:
+            client.request_session()
+
+        product = financial_services.get_product(
+            membersuite_id=self.product_id,
+            client=client)
+
+        return product
+
+
+@python_2_unicode_compatible
+class Order(MemberSuiteObject):
+
+    def __init__(self, membersuite_object_data, session_id=None):
+        """Create an Order object from a the Zeep'ed XML representation of
+        a Membersuite Order.
+
+        """
+        super(Order, self).__init__(
+            membersuite_object_data=membersuite_object_data)
+        self.session_id = session_id
+
+    def __str__(self):
+        return ("<Order: ID: {id}, Line Items: {line_items} "
+                " session_id: {session_id}>".format(
+                    id=self.membersuite_id,
+                    line_items=self.line_items,
+                    session_id=self.session_id))
+
+    @property
+    def first_line_item(self):
+        """Returns the first OrderLineItem object for line items in this order.
+        """
+        membersuite_object_data = (
+            self.fields["LineItems"]["MemberSuiteObject"][0])
+        line_item = OrderLineItem(
+            membersuite_object_data=membersuite_object_data)
+        return line_item
+
+    def get_products(self, client=None):
+        """A list of Product objects in this Order.
+        """
+        client = client or get_new_client(request_session=True)
+        if not client.session_id:
+            client.request_session()
+        products = []
+        for line_item in self.line_items:
+            products.append(line_item.get_product(client=client))
+        return products

membersuite_api_client/orders/__init__.py

@@ -0,0 +1,29 @@
+from ..exceptions import ExecuteMSQLError
+from ..utils import get_new_client
+from .models import Order
+
+
+def get_order(membersuite_id, client=None):
+    """Get an Order by ID.
+    """
+    if not membersuite_id:
+        return None
+
+    client = client or get_new_client(request_session=True)
+    if not client.session_id:
+        client.request_session()
+
+    query = "SELECT Object() FROM ORDER WHERE ID = '{}'".format(
+        membersuite_id)
+
+    result = client.runSQL(query)
+
+    msql_result = result["body"]["ExecuteMSQLResult"]
+
+    if msql_result["Success"]:
+        membersuite_object_data = (msql_result["ResultValue"]
+                                   ["SingleObject"])
+    else:
+        raise ExecuteMSQLError(result=result)
+
+    return Order(membersuite_object_data=membersuite_object_data)

membersuite_api_client/orders/models.py

@@ -1,16 +1,35 @@
+# -*- coding: utf-8 -*-
 """
     Models the Subscription object in MemberSuite
 
     http://api.docs.membersuite.com/#References/Objects/Subscription.htm
 """
+from __future__ import unicode_literals
 
+from ..models import MemberSuiteObject
+from ..orders import services as orders_services
 
-class Subscription(object):
 
-    def __init__(self, id, org_id, name, start, end, extra_data={}):
-        self.id = id
-        self.org_id = org_id
-        self.name = name
-        self.start = start
-        self.end = end
-        self.extra_data = extra_data  # all other fields, for reference
+class Subscription(MemberSuiteObject):
+
+    def __init__(self, membersuite_object_data):
+        super(Subscription, self).__init__(
+            membersuite_object_data=membersuite_object_data)
+        self.owner_id = self.fields['Owner']
+        self.start_date = self.fields['StartDate']
+        self.expiration_date = self.fields['ExpirationDate']
+        self.order_id = self.fields['OriginalOrder']
+
+    def get_order(self, client=None):
+        order = orders_services.get_order(membersuite_id=self.order_id,
+                                          client=client)
+        return order
+
+    def get_product(self, client=None):
+        order = self.get_order(client=client)
+        if order:
+            first_line_item = order.first_line_item
+            product = first_line_item.get_product(client=client)
+            return product
+        else:
+            return None

membersuite_api_client/orders/services.py

@@ -8,23 +8,23 @@
     @todo
         add date modified param for performance
 """
-
-from .models import Subscription
 from ..mixins import ChunkQueryMixin
-from ..utils import convert_ms_object
+from ..utils import get_new_client
+from .models import Subscription
 
 import datetime
 
 
 class SubscriptionService(ChunkQueryMixin, object):
 
-    def __init__(self, client):
+    def __init__(self, client=None):
         """
         Accepts a ConciergeClient to connect with MemberSuite
         """
-        self.client = client
+        super(SubscriptionService, self).__init__()
+        self.client = client or get_new_client()
 
-    def get_subscriptions(self, publication_id=None, org_id=None,
+    def get_subscriptions(self, publication_id=None, owner_id=None,
                           since_when=None, limit_to=200, max_calls=None,
                           start_record=0, verbose=False):
         """
@@ -37,8 +37,8 @@ def get_subscriptions(self, publication_id=None, org_id=None,
         # (key, operator, value) tuples
         where_params = []
 
-        if org_id:
-            where_params.append(('owner', '=', "'%s'" % org_id))
+        if owner_id:
+            where_params.append(('owner', '=', "'%s'" % owner_id))
         if publication_id:
             where_params.append(('publication', '=', "'%s'" % publication_id))
         if since_when:
@@ -51,9 +51,6 @@ def get_subscriptions(self, publication_id=None, org_id=None,
             query += " AND ".join(
                 ["%s %s %s" % (p[0], p[1], p[2]) for p in where_params])
 
-        # note, get_long_query is overkill when just looking at
-        # one org, but it still only executes once
-        # `get_long_query` uses `ms_object_to_model` to return Subscriptions
         subscription_list = self.get_long_query(
             query, limit_to=limit_to, max_calls=max_calls,
             start_record=start_record, verbose=verbose)
@@ -62,13 +59,4 @@ def get_subscriptions(self, publication_id=None, org_id=None,
 
     def ms_object_to_model(self, ms_obj):
         " Converts an individual result to a Subscription Model "
-        sane_obj = convert_ms_object(
-            ms_obj['Fields']['KeyValueOfstringanyType'])
-        subscription = Subscription(
-            id=sane_obj['ID'],
-            org_id=sane_obj['Owner'],
-            name=sane_obj['Name'],
-            start=sane_obj['StartDate'],
-            end=sane_obj['ExpirationDate'],
-            extra_data=sane_obj)
-        return subscription
+        return Subscription(membersuite_object_data=ms_obj)