Skip to content
This repository has been archived by the owner on Jan 25, 2024. It is now read-only.

Commit

Permalink
Release 1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
sbossert committed May 18, 2018
1 parent d397ec4 commit 5f30765
Show file tree
Hide file tree
Showing 467 changed files with 122,132 additions and 0 deletions.
201 changes: 201 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
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.
118 changes: 118 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
# Opencart 2.2 Wallee Integration BETA
This repository contains the Opencart wallee payment module that enables the shop to process payments with [wallee](https://wallee.com/).

##### To use this extension, a [wallee](https://wallee.com/) account is required.

## Requirements

* [Opencart](https://www.opencart.com/) 2.2.x
* [PHP](http://php.net/) 5.4 or later

## Documentation

### Prerequisites

1. If you don't already have one, create a [wallee](https://app-wallee.com/user/signup) account, set up a space and sign up for an OpenCart account.
2. Create an application user that is allowed to access the space you want to link to the OpenCart store. Navigate to your wallee account > application user and create your application user. The user ID and the authentication key will be shown to you.

![Application user configuration](screenshots/application_user.png)

3. Make sure that you grant the application users the necessary rights (Account Admin) in order to configure the webhooks, payment methods etc. out of your Opencart store.
4. Setup at least one each of processor, payment method and connector configuration. More information about the [processor concept](https://app-wallee.com/doc/payment) can be found in the documentation.

### Installation

#### Manual installation

The easiest way to install the plugin is by uploading the files directly.

1. Upload the contents of the upload folder to the store's root directory using FTP/SSH.
2. The plugin will now be visible under your **Payments**. You can install the plugin directly from here. After the plugin is installed, you can open the configuration.

#### Extension installer

The plugin can also be installed using OpenCarts **Extension Installer**.

1. Compress the upload folder to a ZIP file.
2. Rename the file extension from .zip to .ocmod.zip
3. Open the **Extension Installer** in your OpenCart backend
4. Upload the zipped directory using the **Extension Installer**
5. The plugin will now be visible under your **Payments**. You can install the plugin directly from here. After the plugin is installed, you can open the configuration.

### Configuration

1. Open the extensions configuration page
2. Enter the User ID, Application User Key and Space ID
3. Configure the status mapping so it matches. The defaults should be correct, but may differ depending on your workflow, or any custom statusses already in use. Check our [transaction states](https://app-wallee.com/en-us/doc/payment/transaction-process) page for more information.
4. Set if you want invoices and packing slips to be available to the customer from the OpenCart frontend.
4. Save the configuration
5. Refresh modifications

The extension will automatically configure itself and create all required files after completing these steps. Payment methods and webhooks are registered automatically and will be available in the store.

If you have configured a separate currency to have a non-1.00 value please be aware that there may be rounding errors due to the way OpenCart handles currency totals and taxes.

Note that webhooks will not arrive if maintenance mode is active. This results in orders not being completed.

![Application user configuration](screenshots/settings.png)

## Features

### Payment methods & webhooks

The extension will pull any configured payment methods and webhooks from your wallee account. Note: The payment methods will not appear in the payment overview of your OpenCart backend.

### Packing slips & invoices

You may allow customers to download their own packing slips and / or invoices. This can be configured in the extension settings page. The download buttons are available in the customers order view. The documents are made available in the PDF format.

![Packing slips & invoices](screenshots/download.png)

### Refunds

The extension allows transactions made with it to also be refunded directly from the opencart backend if the transaction is in the correct state.

![Refund](screenshots/refund.png)

### Completion

Orders can be processed in two steps depending on your wallee configurations. In the case of manual completions the order stays in a reserved state until the merchant confirms that the funds should be transferred. A completion can be initiated from the order view in your OpenCart backend if the transaction is in the correct state.

### Void

Orders which are processed in two steps can be voided instead of completed. A void can be initiated from the order view in your OpenCart backend if the transaction is in the correct state.

### Alerts

If there are open manual tasks in your wallee account, or if a non-synchronous task such as a void, completion or refund fails, this information is displayed in your OpenCart backend.

![Alerts](screenshots/alerts.png)

### Transaction Information

Most information regarding the transaction can be directly viewed from the OpenCart backend. This includes any configured labels, invoices and packing slips. If there have been any completions, voids or refunds initiated from the OpenCart backend these will also be visible.

![Transaction Information](screenshots/transaction.png)

### Further information

Have a look at our documentation to get to know wallee in more details. There are a lot of interesting features that could be beneficial to you and save you a lot of money and time in your daily operations. Below there is just a list of the most important and most used features.

* [ESR Orange Einzahlungsscheine](https://wallee.com/features/esr.html)
* [Document Templates](https://wallee.com/features/document-handling.html)
* [Integrated Processors](https://app-wallee.com/en/processors)
* [E-Mail Templates](https://wallee.com/features/document-handling.html)
* [Cloud Printing](https://wallee.com/features/cloud-printing.html)
* [Payment Routing](https://wallee.com/features/intelligent-payment-routing.html)

### Support

If you have questions use the support form in your space or use the [online form](https://wallee.com/support.html).

## License

Please see the [license file](./LICENSE) for more information.

## Other Opencart Versions

Find the module for different Opencart versions [here](https://github.com/wallee-payment/opencart).
Binary file added screenshots/alerts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/application_user.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/download.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/refund.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/transaction.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
52 changes: 52 additions & 0 deletions upload/admin/controller/extension/wallee/alert.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<?php
require_once modification(DIR_SYSTEM . 'library/wallee/helper.php');

/**
* Handles the display of alerts in the top right.
* Is used in combination with
* - model/extension/wallee/alert.php
* - system/library/wallee/modification/WalleeAlerts.ocmod.xml
*/
class ControllerExtensionWalleeAlert extends Wallee\Controller\AbstractEvent {

/**
* Redirects the user to the manual task overview in the wallee backend.
*/
public function manual(){
try {
$this->validate();
$this->response->redirect(\WalleeHelper::getBaseUrl() . '/s/' . $this->config->get('wallee_space_id') . '/manual-task/list');
}
catch (Exception $e) {
$this->displayError($e->getMessage());
}
}

/**
* Redirect the user to the order with the oldest checkable failed job.
*/
public function failed(){
try {
$oldest_failed = \Wallee\Entity\RefundJob::loadOldestCheckable($this->registry);
if (!$oldest_failed->getId()) {
$oldest_failed = \Wallee\Entity\CompletionJob::loadOldestCheckable($this->registry);
}
if (!$oldest_failed->getId()) {
$oldest_failed = \Wallee\Entity\VoidJob::loadOldestCheckable($this->registry);
}
$this->response->redirect(
$this->createUrl('sale/order/info',
array(
\WalleeVersionHelper::TOKEN => $this->session->data[\WalleeVersionHelper::TOKEN],
'order_id' => $oldest_failed->getOrderId()
)));
}
catch (Exception $e) {
$this->displayError($e->getMessage());
}
}

protected function getRequiredPermission(){
return 'extension/wallee/alert';
}
}
Loading

0 comments on commit 5f30765

Please sign in to comment.