merged changes

Author: brianmc

README.md

@@ -11,6 +11,7 @@ Installations
 Run the following to get pyxb and nosetests:
 - pip install pyxb
 - pip install nosetests
+- pip install Magicmock
 
 Testing
 --------------------------------------
@@ -19,12 +20,16 @@ Testing
 
 How to Use
 --------------------------------------
+You need to set your credentials.
+Refer to template given in anet_python_sdk_properties.ini
+Either copy it to your root directory or make a new one similar to this. If you create one name file anet_python_sdk_properties.ini
+
 The following is a sample which shows how to create a transaction request 
 and execute it using the create transaction controller.
 
-from contract import binding
+from authorizenet import apicontractsv1
 from decimal import *
-from controller.CreateTransactionController import CreateTransactionController
+from authorizenet.apicontrollers import CreateTransactionController
 
 class paymentTransaction(object):
 

properties.ini renamed to anet_python_sdk_properties_template.ini

@@ -2,7 +2,7 @@
 
 #sandbox cradentials
 api.login.id : 6rF76h2U93AL
-transaction.key : 59j3B2Kq7r8Fyg76
+transaction.key : 7jh86zEUhy7228FG 
 md5.hash.key : MD5_HASH_KEY
 
 #log
@@ -12,6 +12,4 @@ logfilename : logFile.log
 #http://proxy.yourcompany.com:80
 #https://proxy.yourcompany.com:443
 
-#environments
-sandbox : https://apitest.authorize.net/xml/v1/request.api
-production : https://api2.authorize.net/xml/v1/request.api
+

authorizenet/apicontrollersbase.py

@@ -1,17 +1,20 @@
 '''
-Created on Jul 6, 2015
+Created on Nov 1, 2015
 
-@author: egodolja
+@author: krgupta
 '''
 import abc
 import logging
 import os
+from os.path import expanduser
+
 import sys
 import xml.dom.minidom
 
 from pip._vendor import requests
 from _pyio import __metaclass__
 from ConfigParser import SafeConfigParser
+import ConfigParser
 
 from authorizenet.constants import constants
 from authorizenet import apicontractsv1
@@ -34,27 +37,27 @@ def getresponseclass(self):
         pass
 
     @abc.abstractmethod
-    def getResponse(self):
+    def getresponse(self):
         ''' Returns the de-serialized response'''
         pass
 
     @abc.abstractmethod
-    def getResultCode(self):
+    def getresultcode(self):
         ''' Returns the result code from the response '''
         pass
 
     @abc.abstractmethod
-    def getMessageType(self):
+    def getmessagetype(self):
         ''' Returns the message type enum from the response '''
         pass
 
     @abc.abstractmethod
-    def afterExecute(self):
-        '''TODO'''
+    def afterexecute(self):
+        '''Returns the message received from binding after processing request'''
         pass
 
     @abc.abstractmethod
-    def beforeExecute(self):
+    def beforeexecute(self):
         '''TODO'''
         pass
 
@@ -63,16 +66,28 @@ class APIOperationBase(APIOperationBaseInterface):
 
     parser = SafeConfigParser({"http":"","https":"","ftp":""})
 
+   
     try:
-        #if #TODO
-        parser.read(os.path.dirname(__file__) + "/../properties.ini")
+        #if #TODO      
+        home = os.path.expanduser("~")
+        homedirpropertiesfilename = os.path.join(home, "anet_python_sdk_properties.ini")
+        
+        currdir = os.getcwd()
+        currdirpropertiesfilename = os.path.join(currdir, "anet_python_sdk_properties.ini")
+        
+        if (os.path.exists(homedirpropertiesfilename)):
+            parser.read(homedirpropertiesfilename)
+        elif (os.path.exists(currdirpropertiesfilename)):
+            parser.read(currdirpropertiesfilename)
+        else :
+            print "you do not have anet_python_sdk_properties.ini file neither in home nor in current working directory"
     except IOError, error:
         sys.exit( error)
     else:
         logFile = parser.get("properties", "logfilename")
         #TODO format and level in config file
         logging.basicConfig(filename=logFile, level=logging.DEBUG, format='%(asctime)s %(message)s')
-        endpoint = parser.get("properties", "sandbox")
+        endpoint = constants.SANDBOX_TESTMODE 
 
     @abc.abstractmethod
     def validaterequest(self):
@@ -94,10 +109,10 @@ def validate(self):
         self.validaterequest() 
         return     
 
-    def _getRequest(self): #protected method
+    def _getrequest(self): #protected method
         return self._request 
 
-    def buildRequest(self):
+    def buildrequest(self):
         logging.debug('building request..')
         #TODO requestType = type( self._request)
         requestType = self._requestType
@@ -109,8 +124,8 @@ def buildRequest(self):
 
         return xmlRequest
 
-    def getPrettyXmlRequest(self):
-        xmlRequest = self.buildRequest()
+    def getprettyxmlrequest(self):
+        xmlRequest = self.buildrequest()
         requestDom = xml.dom.minidom.parseString(xmlRequest)
         logging.debug('Request is: %s' % requestDom.toprettyxml())
 
@@ -119,26 +134,26 @@ def getPrettyXmlRequest(self):
     def execute(self):
         logging.debug('Executing http post to url: %s', self.endpoint)
 
-        self.beforeExecute()
+        self.beforeexecute()
 
         proxyDictionary = {'http' : self.parser.get("properties", "http"),
                             'https' : self.parser.get("properties" , "https"),
                             'ftp' : self.parser.get("properties", "ftp")}
 
         #requests is http request
         try:
-            xmlRequest = self.buildRequest()
+            xmlRequest = self.buildrequest()
             self._httpResponse = requests.post(self.endpoint, data=xmlRequest, headers=constants.headers, proxies=proxyDictionary)
         except Exception as httpException:
-            logging.error( 'Error retrieving http response from: %s for request: %s', self.endpoint, self.getPrettyXmlRequest())
+            logging.error( 'Error retrieving http response from: %s for request: %s', self.endpoint, self.getprettyxmlrequest())
             logging.error( 'Exception: %s, %s', type(httpException), httpException.args )
 
 
         if self._httpResponse:
             #encoding of response should be changed to retrieve text of response
             self._httpResponse.encoding = constants.response_encoding
             self._httpResponse = self._httpResponse.text[3:] #strip BOM
-            self.afterExecute()
+            self.afterexecute()
             try:
                 self._response = apicontractsv1.CreateFromDocument(self._httpResponse)
             except Exception as createfromdocumentexception:
@@ -156,21 +171,21 @@ def execute(self):
         else:
             print "Did not receive http response"
 
-    def getResponse(self):
+    def getresponse(self):
         return self._response
 
-    def getResultCode(self):
+    def getresultcode(self):
         if self._response:
             return self._response.resultCode
 
-    def getMessageType(self):
+    def getmessagetype(self):
         if self._response:
             return self._response.message
 
-    def afterExecute(self ):
+    def afterexecute(self ):
         return 
 
-    def beforeExecute(self):
+    def beforeexecute(self):
         return 
 
     def __init__(self, apiRequest, requestType):

authorizenet/constants.py

@@ -4,6 +4,10 @@
 @author: egodolja
 '''
 class constants(object):
+    """All the constants are defined here
+    Define all your constants instead of using magic numbers in the
+    code. 
+    """
 
     '''Environments'''
     SANDBOX_TESTMODE = 'https://apitest.authorize.net/xml/v1/request.api'

setup.py

@@ -2,7 +2,8 @@
 """
 
 # Always prefer setuptools over distutils
-from setuptools import setup, find_packages
+from setuptools import setup
+from setuptools import find_packages
 # To use a consistent encoding
 from codecs import open
 from os import path
@@ -75,6 +76,11 @@
         #'dev': ['check-manifest'],
         #'test': ['coverage'],
     },
+    environment_variables={
+        #api.login.id : xyz
+        #transaction.key : xyz 
+        #md5.hash.key : MD5_HASH_KEY
+    },
 
     # If there are data files included in your packages that need to be
     # installed, specify them here.  If using Python 2.6 or less, then these

tests/apitestbase.py

@@ -19,7 +19,18 @@ class ApiTestBase(unittest.TestCase):
     def setUp(self):
         self.amount = str(round(random.random()*100, 2))
         parser = SafeConfigParser()
-        parser.read(os.path.dirname(__file__)+ "/../properties.ini")
+        home = os.path.expanduser("~")
+        homedirpropertiesfilename = os.path.join(home, "anet_python_sdk_properties.ini")
+        
+        currdir = os.getcwd()
+        currdirpropertiesfilename = os.path.join(currdir, "anet_python_sdk_properties.ini")
+        
+        if (os.path.exists(homedirpropertiesfilename)):
+            parser.read(homedirpropertiesfilename)
+        elif (os.path.exists(currdirpropertiesfilename)):
+            parser.read(currdirpropertiesfilename)
+        else :
+            print "you do not have anet_python_sdk_properties.ini file neither in home nor in current working directory"
 
         self.api_login_id = parser.get("properties", "api.login.id")
         self.transaction_key = parser.get("properties", "transaction.key")
@@ -73,5 +84,6 @@ def setUp(self):
         self.billTo.state = "WA"
         self.billTo.zip = "98122"
         self.billTo.country = "USA"
-        
+       
+