Merge pull request #10 from AASHE/client-parameters

Subscription Service

Author: jamstooks

.coveragerc

@@ -1,2 +1,7 @@
 [run]
-source = membersuite-api-client
+source = membersuite_api_client
+
+omit =
+    */python?.?/*
+    */site-packages/*
+    */unittest2/*

.travis.yml

@@ -5,7 +5,8 @@ python:
 - '3.5'
 install:
 - pip install -r requirements.txt
-script: coverage run membersuite-api-client/tests.py
+- pip install -r requirements_test.txt
+script: nosetests --with-coverage
 after_success: coveralls
 notifications:
   hipchat: 5534a6204d6caa1a45ac2444282aca@WebDevActivity

MANIFEST.in

@@ -1,4 +1,4 @@
 include LICENSE
 include README.md
 include setup.py
-recursive-include membersuite-api-client *
+recursive-include membersuite_api_client *

membersuite-api-client/__init__.py membersuite_api_client/__init__.pymembersuite-api-client/__init__.py renamed to membersuite_api_client/__init__.py

@@ -144,3 +144,14 @@ def convert_ms_object(self, ms_object):
         for item in ms_object:
             out_dict[item["Key"]] = item["Value"]
         return out_dict
+
+    def runSQL(self, query, start_record=0):
+        concierge_request_header = self.construct_concierge_header(
+            url="http://membersuite.com/contracts/"
+                "IConciergeAPIService/ExecuteMSQL")
+        result = self.client.service.ExecuteMSQL(
+            _soapheaders=[concierge_request_header],
+            msqlStatement=query,
+            startRecord=start_record
+        )
+        return result

membersuite-api-client/client.py membersuite_api_client/client.pymembersuite-api-client/client.py renamed to membersuite_api_client/client.py

@@ -0,0 +1,15 @@
+"""
+    Models the Subscription object in MemberSuite
+
+    http://api.docs.membersuite.com/#References/Objects/Subscription.htm
+"""
+
+
+class Subscription(object):
+
+    def __init__(self, id, org, start, end, extra_data={}):
+        self.id = id
+        self.org = org
+        self.start = start
+        self.end = end
+        self.extra_data = extra_data  # all other fields, for reference

membersuite_api_client/subscriptions/__init__.py

@@ -0,0 +1,64 @@
+"""
+    The service for connecting to MemberSuite for SubscriptionService
+
+    http://api.docs.membersuite.com/#References/Objects/Subscription.htm
+
+    @todo
+        let's define an Organization object, like this Subscription,
+        for this interface
+    @todo
+        confirm owner field is actually the orgnization
+    @todo
+        set up fixtures in MemberSuite for integration testing
+    @todo
+        add date modified param for performance
+    @todo
+        additional method for getting all subscriptions for syncing purposes
+"""
+
+from .models import Subscription
+
+
+class SubscriptionService(object):
+
+    def __init__(self, client):
+        """
+        Accepts a ConciergeClient to connect with MemberSuite
+        """
+        self.client = client
+
+    def get_org_subscriptions(self, org_id, publication_id=None):
+        """
+        Get all the subscriptions for a given organization
+
+        Returns a list of subscription objects
+        """
+        query = "SELECT Objects() FROM Subscription"
+        query += " WHERE owner = '%s'" % org_id
+
+        if publication_id:
+            query += "AND publication = '%s'" % publication_id
+
+        result = self.client.runSQL(query)
+        mysql_result = result['body']['ExecuteMSQLResult']
+
+        if not mysql_result['Errors']:
+            obj_result = mysql_result['ResultValue']['ObjectSearchResult']
+            objects = obj_result['Objects']['MemberSuiteObject']
+
+            subscription_list = []
+            for obj in objects:
+                sane_obj = self.client.convert_ms_object(
+                    obj['Fields']['KeyValueOfstringanyType'])
+                subscription = Subscription(
+                    id=sane_obj['ID'],
+                    org=org_id,
+                    start=sane_obj['StartDate'],
+                    end=sane_obj['TerminationDate'],
+                    extra_data=sane_obj)
+                subscription_list.append(subscription)
+
+            return subscription_list
+
+        else:
+            return None

membersuite_api_client/subscriptions/models.py

@@ -0,0 +1,17 @@
+import os
+import unittest
+
+from ..client import ConciergeClient
+
+
+class BaseTestCase(unittest.TestCase):
+
+    def setUp(self):
+        self.MS_ACCESS_KEY = os.environ["MS_ACCESS_KEY"]
+        self.MS_SECRET_KEY = os.environ["MS_SECRET_KEY"]
+        self.MS_ASSOCIATION_ID = os.environ["MS_ASSOCIATION_ID"]
+
+        self.client = ConciergeClient(
+            access_key=self.MS_ACCESS_KEY,
+            secret_key=self.MS_SECRET_KEY,
+            association_id=self.MS_ASSOCIATION_ID)