Permalink
Browse files

initial commit

  • Loading branch information...
0 parents commit 75eadc89f6358d21a293081c887200f2fa9e893e @zupo zupo committed Dec 19, 2012
@@ -0,0 +1,9 @@
+.installed.cfg
+.mr.developer.cfg
+bin
+develop-eggs
+docs/html
+include
+lib
+parts
+var
@@ -0,0 +1,13 @@
+language: python
+python:
+ - {{{ python.version }}}
+
+install:
+ - make python=$( which python ) .installed.cfg
+
+script:
+ - make tests
+
+notifications:
+ irc:
+ - "{{{ author.irc }}}"
@@ -0,0 +1,2 @@
+graft src/niteoweb
+include *.cfg *.rst *.in
@@ -0,0 +1,32 @@
+# convenience makefile to boostrap & run buildout
+# use `make options=-v` to run buildout with extra options
+
+version = 2.7
+python = bin/python
+options =
+
+all: docs tests
+
+.installed.cfg: bin/buildout buildout.cfg buildout.d/*.cfg setup.py
+ bin/buildout $(options)
+
+bin/buildout: $(python) buildout.cfg bootstrap.py
+ $(python) bootstrap.py -d
+ @touch $@
+
+$(python):
+ virtualenv-$(version) --no-site-packages .
+ @touch $@
+
+tests: .installed.cfg
+ @bin/test
+ @bin/flake8 src/niteoweb/ipn/jvzoo
+ @for pt in `find src/niteoweb/ipn/jvzoo -name "*.pt"` ; do bin/zptlint $$pt; done
+ @for xml in `find src/niteoweb/ipn/jvzoo -name "*.xml"` ; do bin/zptlint $$xml; done
+ @for zcml in `find src/niteoweb/ipn/jvzoo -name "*.zcml"` ; do bin/zptlint $$zcml; done
+
+clean:
+ @rm -rf .installed.cfg bin parts develop-eggs \
+ src/niteoweb.ipn.jvzoo.egg-info lib include .Python
+
+.PHONY: all tests clean
@@ -0,0 +1,82 @@
+================
+niteoweb.ipn.jvzoo
+================
+
+A Plone add-on that that integrates JVZoo digital products retailer system with
+Plone to enable paid memberships on your site.
+
+* `Source code @ GitHub <https://github.com/niteoweb/niteoweb.ipn.jvzoo>`_
+* `Releases @ PyPI <http://pypi.python.org/pypi/niteoweb.ipn.jvzoo>`_
+* `Documentation @ ReadTheDocs <http://niteowebipnjvz.readthedocs.org>`_
+* `Continuous Integration @ Travis-CI <http://travis-ci.org/niteoweb/niteoweb.ipn.jvzoo>`_
+
+
+How it works
+============
+
+#. Visitor comes to your site and clicks an Order link.
+
+#. Visitor is sent to JVZoo's order form (on http://jvzoo.com), where she
+ enters her personal information and performs payment.
+
+#. If payment was successful, JVZoo sends a POST request to a special view on
+ your Plone site (``/@@jvzoo``).
+
+#. The ``@@jvzoo`` view parses this POST data from JVZoo and verifies it
+ against the `Secret Key` you've set in the `Plone control panel`.
+
+#. If all checks out, ``@@jvzoo`` calls an appropriate action provided by the
+ ``niteoweb.ipn`` package (on which this package depends on).
+
+
+Transaction type to ``niteoweb.ipn`` action mapping
+===================================================
+
+JVZoo supports different `Transaction types`, like `Sale`, `Cancellation`,
+`Refund`, etc. These are mapped to actions provided by ``niteoweb.ipn``.
+
+
+Installation
+============
+
+To install `niteoweb.ipn.jvzoo` you simply add ``niteoweb.ipn.jvzoo``
+to the list of eggs in your buildout, run buildout and restart Plone.
+Then, install `niteoweb.ipn.jvzoo` using the Add-ons control panel.
+
+Configuration
+=============
+
+JVZoo
+-----
+
+Go to `JVZoo.com <http://jvzoo.com>`_ and use ``Sellers`` ->
+``Add a Product`` to add a new `Product`.
+
+Then check the option ``External Program Integration``. For `URL`
+set ``http://yoursite.com/@@jvzoo``. Under the ``My Account`` page
+set the ``JVZIPN Secret Key``.
+
+
+Plone
+-----
+
+Go to ``Site Setup`` -> ``jvzoo`` control panel form and configure
+the ``Secret Key`` field by pasting in the `Secret Key` you defined above.
+
+
+Test it
+=======
+
+You are now ready to do a test buy! Go back to ``Sellers`` and click
+``Test Purchases``. Select a product, click ``Create Test Purchase Code`` and
+finish by clicking the link in ``Buy / Link`` column in the table below. In
+order for the purchase link to work, the product needs to be activated in
+``Sellers Dashboard`` (select a product and check ``Allow Sales``).
+
+Before you finish the transaction, you of course need to set up your Plone
+site to receive JVZoo server notifications.
+
+Confirm by logging-in to http://jvzoo.com and checking to see if there were any
+purchases (on ``Sellers`` tab). Also check if your received an email with
+username and password for accessing your site and try to login with them.
+
Oops, something went wrong. Retry.

0 comments on commit 75eadc8

Please sign in to comment.