Skip to content

Commit

Permalink
Updates to improve structure
Browse files Browse the repository at this point in the history
  • Loading branch information
@alexanderdean
alexanderdean committed May 1, 2012
1 parent 40f6408 commit 11dc65f
Show file tree
Hide file tree
Showing 3 changed files with 376 additions and 145 deletions.
202 changes: 202 additions & 0 deletions LICENSE-2.0.txt
View file
@@ -0,0 +1,202 @@

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
174 changes: 174 additions & 0 deletions README.md
View file
@@ -0,0 +1,174 @@
# Symfony2 PayPal IPN Bundle

## Overview

symfony2-paypal-ipn is a Symfony2 bundle for working with the PayPal IPN (Instant Payment Notification) service.
The bundle acts as a listener for the PayPal IPN service and logs the incoming orders to your database using Doctrine.

## Description

symfony2-paypal-ipn is a near-direct port of [codeigniter-paypal-ipn] [codeigniterpaypalipn], an equivalent library for CodeIgniter users. symfony2-paypal-ipn acts as a listener for the PayPal Instant Payment Notification (IPN) interface, and
uses Doctrine 2.0 to log the received orders to your database.

This library (bundle in Symfony2 language) focuses on the "post-payment" workflow, i.e. the processing required once the
payment has been made and PayPal has posted an Instant Payment Notification call to the IPN controller.

This library handles:

* Validating the IPN call
* Logging the IPN call
* Extracting the order and line item information from the IPN call
* Interpreting PayPal's payment status
* Storing the order and line items in the database

All pre-payment functionality (e.g. posting the checkout information to PayPal) and custom post-payment workflow (e.g.
sending emails) is left as an exercise for the reader. For a much more general-purpose PayPal toolkit for Symfony2, please
see the [JMSPaymentPaypalBundle] [jmspaymentbundle].

## Dependencies

The Symfony PayPal IPN Bundle depends on the PHP framework [Symfony2] [symfony2] and [Doctrine 2.0] [doctrine2.0]. An example order confirmation email built in the [Twig] [twig] templating language is also provided.

## Installation

### 1. Install and register the bundle

First copy `src/Orderly` from this repository to your project's own `src` directory. The `OrderlyPayPalIpnBundle.php` file
should now be available here:

[[Your Symfony2 root]]/src/Orderly/PaypalIpnBundle/OrderlyPayPalIpnBundle.php

Next, we need to register the new bundle. So edit your `AppKernel.php` file:

[[Your Symfony2 root]]/app/AppKernel.php

and add the following to the end of the `$bundles` array in the `registerBundles()` method:

new Orderly\PayPalIpnBundle\OrderlyPayPalIpnBundle()

### 2. Deploy the database tables

To create the MySQL tables required by PayPalIpnBundle, the **recommended** approach is to run the
`create_mysql_tables.sql` SQL file against your database. You can find the file here:

`src/Orderly/PayPalIpnBundle/Resources/config`

The alternative approach is to install the tables by type the following in your project console:

php app/console doctrine:schema:update --force

Note that this second method does **not** copy across the table field comments found in the SQL file.

### 4. Setup routing (suggested fourth step)

To tell the Symfony2 routing system where to find one of our sample controllers, first open up the
following file:

[[Your Symfony2 root]]/app/config/routing.yml

If you want to send order confirmation emails using Twig, then add in this controller:

OrderlyPayPalIpnBundleEmail:
resource: "@OrderlyPayPalIpnBundle/Controller/TwigNotificationEmailController.php"
type: annotation
prefix: /ipn/

Your site will now be listening for incoming Instant Payment Notifications on the URL:

http://[[Your domain]]/ipn/ipn-twig-email-notification

Alternatively if you just want to log orders in the database (and not send out any notifications), then add
in this controller:

OrderlyPayPalIpnBundleNoEmail:
resource: "@OrderlyPayPalIpnBundle/Controller/NoNotificationController.php"
type: annotation
prefix: /ipn/

Your site will now be listening for incoming IPNs on:

http://[[Your domain]]/ipn/ipn-no-notification

**Disclaimer: the sample controllers provided are exactly that - samples. Please update one or other of these
sample files with your own business logic before putting this bundle into production.**

h2. Configuration

bc.. // YAML
orderly_pay_pal_ipn:
# Constants for the live environment
email: sales@CHANGEME.com
url: https://www.paypal.com/cgi-bin/webscr
debug: %kernel.debug%
# Debugging simply caches the latest PayPal IPN post data into the database, and retrieves it if
# validateIPN is called without post data. This is useful for directly trying a validateIPN call from
# the controller.

# Constants for the sandbox environment ; Default settings configured in Configuration.php
sandbox_email: seller@paypalsandbox.com
sandbox_url: https://www.sandbox.paypal.com/cgi-bin/webscr
sandbox_debug: true

# islive: if set to false then service loads settings with "sandbox_" prefix
islive: false

## Support

For support requests, please contact [Orderly Ltd] [orderlyemail] or raise a [GitHub issue] [newissue].

## Credits

This library is a port from the [Codeigniter PayPal IPN library] [codeigniterpaypalipn] written by [Alex Dean] [alexdean].

The contributors to symfony2-paypal-ipn are as follows:

* Author: [Kemor] [kemor]
* Contributor: [Strife] [strife]
* Contributor: [Alex Dean] [alexdean]

## Disclaimer and warning

Orderly Ltd does not accept any liability for any processing errors made by the Symfony2 PayPal
IPN Bundle, or any financial losses incurred through its use.

In particular, this library does *not* fulfil the PayPal IPN requirement to:

> verify that the payment amount actually matches what you intend to charge. Although not technically
> an IPN issue, if you do not encrypt buttons, it is possible for someone to capture the original
> transmission and change the price. Without this check, you could accept a lesser payment
> than what you expected.
(This verification step is out of scope for this bundle because it would require integration with
your product catalogue.)

Additionally this library does *not* properly handle refunds. Typically refunds are stored as
a new order line in `ipn_orders` with a negative balance, but even this is not 100% predicatable.

## Copyright

symfony2-paypal-ipn is copyright (c) 2012 Orderly Ltd.

## License

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

[codeigniterpaypalipn]: https://github.com/orderly/codeigniter-paypal-ipn
[jmspaymentbundle]: https://github.com/schmittjoh/JMSPaymentPaypalBundle
[symfony2]: http://symfony.com/
[doctrine2.0]: http://www.doctrine-project.org/
[twig]: http://twig.sensiolabs.org/
[orderlyemail]: orderly-support@keplarllp.com
[newissue]: https://github.com/orderly/symfony2-paypal-ipn/issues/new
[kemor]: https://github.com/kemor
[strife]: https://github.com/strife
[alexdean]: https://github.com/alexanderdean

0 comments on commit 11dc65f

Please sign in to comment.