Updates to the documentation for the previous commit.

arjunchitturi · Apr 20, 2012 · e25ca4c · e25ca4c
1 parent 48e73c1
commit e25ca4c
Show file tree

Hide file tree

Showing 15 changed files with 119 additions and 42 deletions.
diff --git a/docs/gateways/authorize_net.rst b/docs/gateways/authorize_net.rst
@@ -11,8 +11,13 @@ Usage
 * Add the following attributes to your `settings.py`::
 
     MERCHANT_TEST_MODE = True         # Toggle for live transactions
-    AUTHORIZE_LOGIN_ID = "???"
-    AUTHORIZE_TRANSACTION_KEY = "???"
+    MERCHANT_SETTINGS = {
+        "authorize_net": {
+            "LOGIN_ID" : "???",
+            "TRANSACTION_KEY" : "???"
+	}
+        ...
+    }
 
 * Use the gateway instance::
 

diff --git a/docs/gateways/braintree_payments.rst b/docs/gateways/braintree_payments.rst
@@ -11,14 +11,7 @@ any redirects and only Server to Server calls happen in the background.
    You will require the official `braintree`_ python package offered by Braintree
    for this gateway to work.
 
-Settings attributes required for this integration are:
-
-* ``BRAINTREE_MERCHANT_ACCOUNT_ID``: The merchant account id provided by Braintree.
-  Can be obtained from the account dashboard.
-* ``BRAINTREE_PUBLIC_KEY``: The public key provided by Braintree through their account
-  dashboard.
-* ``BRAINTREE_PRIVATE_KEY``: The private key provided by Braintree through their account
-  dashboard.
+Refer to the :doc:`Braintree Payments Server to Server <gateways/braintree_payments>` Gateway for the settings attributes.
 
 Example:
 ---------

diff --git a/docs/gateways/eway_gateway.rst b/docs/gateways/eway_gateway.rst
@@ -16,10 +16,14 @@ Usage
 * Add the following attributes to your `settings.py`::
 
     MERCHANT_TEST_MODE = True
-    EWAY_CUSTOMER_ID = "???"  # Only used for live transactions
-    EWAY_USERAME = "???"
-    EWAY_PASSWORD = "???"
-    EWAY_TEST_CUSTOMER_ID = "???"  # Used for testing
+    MERCHANT_SETTINGS = {
+        "eway": {
+            "CUSTOMER_ID": "???", # Only used for live transactions
+            "USERNAME": "???",
+            "PASSWORD": "???",
+            "TEST_CUSTOMER_ID": "???" # Used for testing
+        }
+    }
     
 * Use the gateway instance::
 

diff --git a/docs/gateways/paypal_gateway.rst b/docs/gateways/paypal_gateway.rst
@@ -19,10 +19,21 @@ Usage
 * Also add the following attributes to your `settings.py`::
 
     MERCHANT_TEST_MODE = True    # Toggle for live transactions
+    MERCHANT_SETTINGS = {
+        "pay_pal": {
+            "WPP_USER" : "???",
+            "WPP_PASSWORD" : "???",
+            "WPP_SIGNATURE" : "???"
+        }
+    }
+
+    # Since merchant relies on django-paypal
+    # you have to additionally provide the
+    # below attributes
     PAYPAL_TEST = MERCHANT_TEST_MODE
-    PAYPAL_WPP_USER = "???"
-    PAYPAL_WPP_PASSWORD = "???"
-    PAYPAL_WPP_SIGNATURE = "???"
+    PAYPAL_WPP_USER = MERCHANT_SETTINGS["pay_pal"]["WPP_USER"]
+    PAYPAL_WPP_PASSWORD = MERCHANT_SETTINGS["pay_pal"]["WPP_PASSWORD"]
+    PAYPAL_WPP_SIGNATURE = MERCHANT_SETTINGS["pay_pal"]["WPP_SIGNATURE"]
 
 * Run `python manage.py syncdb` to get the response tables.
 * Use the gateway instance::

diff --git a/docs/gateways/samurai_gateway.rst b/docs/gateways/samurai_gateway.rst
@@ -13,13 +13,25 @@ any redirects and only Server to Server calls happen in the background.
 
 Settings attributes required for this integration are:
 
-* ``SAMURAI_MERCHANT_KEY``: The merchant  key  provided by Samurai.
+* ``MERCHANT_KEY``: The merchant  key  provided by Samurai.
   Can be obtained from the account dashboard.
-* ``SAMURAI_MERCHANT_PASSWORD``: The merchant password  provided by Samurai through their account
+* ``MERCHANT_PASSWORD``: The merchant password  provided by Samurai through their account
   dashboard.
-* ``SAMURAI_PROCESSOR_TOKEN``: The processor token  provided by Samurai  through their account
+* ``PROCESSOR_TOKEN``: The processor token  provided by Samurai  through their account
   dashboard.
 
+Settings attributes::
+
+    MERCHANT_TEST_MODE = True # Toggle for live
+    MERCHANT_SETTINGS = {
+        "samurai": {
+            "MERCHANT_KEY": "???",
+            "MERCHANT_PASSWORD": "???",
+            "PROCESSOR_TOKEN": "???"
+        }
+        ...
+    }
+
 Example:
 ---------
 

diff --git a/docs/gateways/stripe_payment.rst b/docs/gateways/stripe_payment.rst
@@ -13,9 +13,20 @@ any redirects and only Server to Server calls happen in the background.
 
 Settings attributes required for this integration are:
 
-* ``STRIPE_API_KEY``: The merchant api key is provided by Stripe.
+* ``API_KEY``: The merchant api key is provided by Stripe.
   Can be obtained from the account dashboard.
 
+Settings attributes::
+
+    MERCHANT_TEST_MODE = True # Toggle for live
+    MERCHANT_SETTINGS = {
+        "stripe": {
+            "API_KEY": "???",
+            "PUBLISHABLE_KEY": "???", # Used for stripe integration
+        }
+        ...
+    }
+
 
 Example:
 ---------

diff --git a/docs/index.rst b/docs/index.rst
@@ -18,12 +18,12 @@ Contents:
 
   * :doc:`On-site Processing <onsite_processing>`
 
-    * :doc:`PayPal <gateways/paypal_gateway>`
     * :doc:`Authorize.Net <gateways/authorize_net>`
-    * :doc:`eWay <gateways/eway_gateway>`
     * :doc:`Braintree Payments Server to Server <gateways/braintree_payments>`
-    * :doc:`Stripe Payments  <gateways/stripe_payment>`
+    * :doc:`eWay <gateways/eway_gateway>`
+    * :doc:`PayPal <gateways/paypal_gateway>`
     * :doc:`Samurai Payment <gateways/samurai_gateway>`
+    * :doc:`Stripe Payments  <gateways/stripe_payment>`
 
   * :doc:`Off-site Processing <offsite_processing>`
 

diff --git a/docs/offsite/amazon_fps.rst b/docs/offsite/amazon_fps.rst
@@ -26,6 +26,16 @@ Settings attributes required for this integration are:
 * ``AWS_SECRET_ACCESS_KEY``: The Amazon AWS secret access key also available from the
   user's dashboard. Shouldn't be distributed to anyone.
 
+Settings attributes::
+
+    MERCHANT_TEST_MODE = True
+    MERCHANT_SETTINGS = {
+        "amazon_fps": {
+            "AWS_ACCESS_KEY": "???",
+            "AWS_SECRET_ACCESS_KEY": "???"
+        }
+    }
+
 Here are the methods and attributes implemented on the ``AmazonFpsIntegration`` class:
 
 * ``__init__(options = {})``: The constructor takes a dictionary of options that are
@@ -116,7 +126,7 @@ In views.py::
 
 In some_template.html::
 
-    {% load billing_tags %}
+    {% load amazon_fps from amazon_fps_tags %}
     {% amazon_fps fps %}
 
 The above template renders the following code::

diff --git a/docs/offsite/braintree_payments.rst b/docs/offsite/braintree_payments.rst
@@ -12,13 +12,25 @@ Braintree Payments Transparent Redirect
 
 Settings attributes required for this integration are:
 
-* ``BRAINTREE_MERCHANT_ACCOUNT_ID``: The merchant account id provided by Braintree.
+* ``MERCHANT_ACCOUNT_ID``: The merchant account id provided by Braintree.
   Can be obtained from the account dashboard.
-* ``BRAINTREE_PUBLIC_KEY``: The public key provided by Braintree through their account
+* ``PUBLIC_KEY``: The public key provided by Braintree through their account
   dashboard.
-* ``BRAINTREE_PRIVATE_KEY``: The private key provided by Braintree through their account
+* ``PRIVATE_KEY``: The private key provided by Braintree through their account
   dashboard.
 
+Settings attributes::
+
+    MERCHANT_TEST_MODE = True # Toggle for live
+    MERCHANT_SETTINGS = {
+        "braintree_payments": {
+            "MERCHANT_ACCOUNT_ID": "???",
+            "PUBLIC_KEY": "???",
+            "PRIVATE_KEY": "???"
+        }
+        ...
+    }
+
 Here are the methods and attributes implemented on the ``BraintreePaymentsIntegration`` class:
 
 * ``__init__(self, options=None)``: The constructor method that configures the 
@@ -89,7 +101,7 @@ Example:
       
    In the template::
 
-      {% load billing_tags %}
+      {% load braintree_payments from braintree_payments_tags %}
 
       {% braintree_payments bp %}
 

diff --git a/docs/offsite/google_checkout.rst b/docs/offsite/google_checkout.rst
@@ -12,11 +12,22 @@ can be viewed from the django admin.
 
 The setting attributes required for this integration are:
 
-* **GOOGLE_CHECKOUT_MERCHANT_ID**: The merchant id assigned by Google after
+* **MERCHANT_ID**: The merchant id assigned by Google after
   signing up for the service.
-* **GOOGLE_CHECKOUT_MERCHANT_KEY**: A secret key assigned by Google after 
+* **MERCHANT_KEY**: A secret key assigned by Google after 
   signing up for the service.
 
+Settings attributes::
+
+    MERCHANT_TEST_MODE = True # Toggle for live
+    MERCHANT_SETTINGS = {
+        "google_checkout": {
+            "MERCHANT_ID": "???",
+            "MERCHANT_KEY": "???"
+        }
+        ...
+    }
+
 Example
 -------
 
@@ -49,7 +60,7 @@ In views.py::
 
 In some_template.html::
 
-  {% load billing_tags %}
+  {% load google_checkout from google_checkout_tags %}
   {% google_checkout obj %}
 
 Template renders to something like below::

diff --git a/docs/offsite/paypal.rst b/docs/offsite/paypal.rst
@@ -51,7 +51,7 @@ In views.py::
 
 In some_template.html::
 
-  {% load billing_tags %}
+  {% load paypal from paypal_tags %}
   {% paypal obj %}
 
 

diff --git a/docs/offsite/rbs_worldpay.rst b/docs/offsite/rbs_worldpay.rst
@@ -12,9 +12,19 @@ viewed from the django admin.
 
 The settings attribute required for this integration are:
 
-* **WORLDPAY_MD5_SECRET_KEY**: The MD5 secret key chosen by the user
+* **MD5_SECRET_KEY**: The MD5 secret key chosen by the user
   while signing up for the WorldPay Hosted Payments Service.
 
+Settings Attributes::
+
+    MERCHANT_TEST_MODE = True # Toggle for live
+    MERCHANT_SETTINGS = {
+        "world_pay": {
+            "MD5_SECRET_KEY": "???"
+        }
+        ...
+    }
+
 Example
 --------
 

diff --git a/docs/offsite/samurai_integration.rst b/docs/offsite/samurai_integration.rst
@@ -10,9 +10,7 @@ Samurai Payment Integration
    This integration makes use of the official `samurai`_ python package offered
    by Samurai  Payments. Please install it before you use this integration.
 
-Settings attributes required for this integration are:
-
-
+Refer to the :doc:`Samurai Payment <gateways/samurai_gateway>` Gateway for the settings attributes.
 
 Here are the methods and attributes implemented on the ``SamuraiIntegration`` class:
 
@@ -74,7 +72,7 @@ Example:
       
    In the template::
 
-      {% load billing_tags %}
+      {% load samurai_payment from samurai_tags %}
 
       {% samurai_payment samurai_obj %}
 

diff --git a/docs/offsite/stripe_integration.rst b/docs/offsite/stripe_integration.rst
@@ -10,9 +10,7 @@ Stripe Payment Integration
    This integration makes use of the official `stripe`_ python package offered
    by Stripe Payments. Please install it before you use this integration.
 
-Settings attributes required for this integration are:
-
-
+Refer to the :doc:`Stripe Payments  <gateways/stripe_payment>` Gateway for the settings attributes.
 
 Here are the methods and attributes implemented on the ``StripeIntegration`` class:
 
@@ -76,7 +74,7 @@ Example:
       
    In the template::
 
-      {% load billing_tags %}
+      {% load stripe_payment from stripe_tags %}
 
       {% stripe_payment stripe_obj %}
 

diff --git a/docs/offsite_processing.rst b/docs/offsite_processing.rst
@@ -35,6 +35,8 @@ Attributes
 * **test_mode**: Signifies if the integration is in a test mode or 
   production. The default value for this is taken from the `MERCHANT_TEST_MODE`
   setting attribute.
+* **display_name**: A human readable name that is generally used to tag the 
+  errors when the integration is not correctly configured.
 
 Methods
 +++++++