Skip to content

Commit

Permalink
Merge pull request #35 from magento-performance/CABPI-529
Browse files Browse the repository at this point in the history
Cabpi 529 IMS delivery
  • Loading branch information
andimov authored Dec 20, 2022
2 parents 874c359 + 4ddb38f commit 247bdd2
Show file tree
Hide file tree
Showing 262 changed files with 20,035 additions and 2 deletions.
47 changes: 47 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Contributing to Adobe IMS code

Contributions to the Adobe IMS codebase are done using the fork & pull model.
This contribution model has contributors maintaining their own fork of the Adobe IMS repository.
The forked repository is then used to submit a request to the base repository to “pull” a set of changes.
For more information on pull requests please refer to [GitHub Help](https://help.github.com/articles/about-pull-requests/).

Contributions can take the form of new components or features, changes to existing features, tests, documentation (such as developer guides, user guides, examples, or specifications), bug fixes or optimizations.

The Adobe IMS development team or community maintainers will review all issues and contributions submitted by the community of developers in the first in, first out order.
During the review we might require clarifications from the contributor.
If there is no response from the contributor within two weeks, the pull request will be closed.

For more detailed information on contribution please read our [beginners guide](https://github.com/magento/magento2/wiki/Getting-Started).

## Contribution requirements

1. Contributions must adhere to the [Magento coding standards](https://devdocs.magento.com/guides/v2.3/coding-standards/bk-coding-standards.html).
2. Pull requests (PRs) must be accompanied by a meaningful description of their purpose. Comprehensive descriptions increase the chances of a pull request being merged quickly and without additional clarification requests.
3. Commits must be accompanied by meaningful commit messages. Please see the [Adobe IMS Pull Request Template](https://github.com/magento/adobe-ims/blob/master/.github/PULL_REQUEST_TEMPLATE.md) for more information.
4. PRs which include bug fixes must be accompanied with a step-by-step description of how to reproduce the bug.
3. PRs which include new logic or new features must be submitted along with:
* Unit/integration test coverage
* Proposed [documentation](https://devdocs.magento.com) updates. Documentation contributions can be submitted via the [devdocs GitHub](https://github.com/magento/devdocs).
4. For larger features or changes, please [open an issue](https://github.com/magento/adobe-ims/issues) to discuss the proposed changes prior to development. This may prevent duplicate or unnecessary effort and allow other contributors to provide input.

## Contribution process

If you are a new GitHub user, we recommend that you create your own [free github account](https://github.com/signup/free).
This will allow you to collaborate with the Adobe IMS development team, fork the Adobe IMS project and send pull requests.

1. Search current [listed issues](https://github.com/magento/adobe-ims/issues) (open or closed) for similar proposals of intended contribution before starting work on a new contribution.
2. Review the [Contributor License Agreement](https://opensource.adobe.com/cla.html) if this is your first time contributing.
3. Create and test your work.
4. Fork the Adobe IMS repository according to the [Fork A Repository instructions](https://devdocs.magento.com/guides/v2.3/contributor-guide/contributing.html#fork) and when you are ready to send us a pull request – follow the [Create A Pull Request instructions](https://devdocs.magento.com/guides/v2.3/contributor-guide/contributing.html#pull_request).
5. Once your contribution is received the Adobe IMS development team will review the contribution and collaborate with you as needed.

## Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. We expect you to agree to its terms when participating in this project.
The full text is available in the repository [Wiki](https://github.com/magento/magento2/wiki/Magento-Code-of-Conduct).

## Connecting with Community!

If you have any questions, join us in [#adobe-stock](https://magentocommeng.slack.com/messages/CH8BGFX9D) Slack chat. If you are not on our slack, [click here](https://opensource.magento.com/slack) to join.

Need to find a project? Check out the [Slack Channels](https://github.com/magento/magento2/wiki/Slack-Channels) (with listed project info) and the [Magento Community Portal](https://opensource.magento.com/).
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: Bug report
about: Technical issue with the Adobe IMS core components
title: ''
labels: ''
assignees: ''

---

<!---
Please review our guidelines before adding a new issue: https://github.com/magento/magento2/wiki/Issue-reporting-guidelines
Fields marked with (*) are required. Please don't remove the template.
-->

### Preconditions (*)
<!---
Provide the exact Magento version (example: 2.2.5) and any important information on the environment where bug is reproducible.
-->
1.
2.

### Steps to reproduce (*)
<!---
Important: Provide a set of clear steps to reproduce this bug. We can not provide support without clear instructions on how to reproduce.
-->
1.
2.

### Expected result (*)
<!--- Tell us what do you expect to happen. -->
1. [Screenshots, logs or description]
2.

### Actual result (*)
<!--- Tell us what happened instead. Include error messages and issues. -->
1. [Screenshots, logs or description]
2.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
32 changes: 32 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<!---
Thank you for contributing to Adobe IMS project.
To help us process this pull request we recommend that you add the following information:
- Summary of the pull request,
- Issue(s) related to the changes made,
- Manual testing scenarios
Fields marked with (*) are required. Please don't remove the template.
-->

<!--- Please provide a general summary of the Pull Request in the Title above -->

### Description (*)
<!---
Please provide a description of the changes proposed in the pull request.
Letting us know what has changed and why it needed changing will help us validate this pull request.
-->

### Fixed Issues (if relevant)
<!---
If relevant, please provide a list of fixed issues in the format magento/adobe-ims#<issue_number>.
There could be 1 or more issues linked here and it will help us find some more information about the reasoning behind this change.
-->
1. magento/adobe-ims#<issue_number>: Issue title
2. ...

### Manual testing scenarios (*)
<!---
Please provide a set of unambiguous steps to test the proposed code change.
Giving us manual testing scenarios will help with the processing and validation process.
-->
1. ...
2. ...
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.DS_Store
.vscode
thumbs.db
.idea/
145 changes: 145 additions & 0 deletions AdminAdobeIms/Api/Data/ImsWebapiInterface.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/

declare(strict_types=1);

namespace Magento\AdminAdobeIms\Api\Data;

use Magento\Framework\Api\ExtensibleDataInterface;

/**
* Declare the ims token data service object
* @api
*/
interface ImsWebapiInterface extends ExtensibleDataInterface
{
/**
* Get ID
*
* @return int|null
*/
public function getId();

/**
* Get admin user ID
*
* @return int|null
*/
public function getAdminUserId(): ?int;

/**
* Set admin user ID
*
* @param int $value
* @return $this
*/
public function setAdminUserId(int $value): ImsWebapiInterface;

/**
* Get access token hash
*
* @return string|null
*/
public function getAccessTokenHash(): ?string;

/**
* Set access token hash
*
* @param string $value
* @return $this
*/
public function setAccessTokenHash(string $value): ImsWebapiInterface;

/**
* Get access token
*
* @return string|null
*/
public function getAccessToken(): ?string;

/**
* Set access token
*
* @param string $value
* @return $this
*/
public function setAccessToken(string $value): ImsWebapiInterface;

/**
* Get creation time
*
* @return string|null
*/
public function getCreatedAt(): ?string;

/**
* Set creation time
*
* @param string $value
* @return $this
*/
public function setCreatedAt(string $value): ImsWebapiInterface;

/**
* Get update time
*
* @return string|null
*/
public function getUpdatedAt(): ?string;

/**
* Set update time
*
* @param string $value
* @return $this
*/
public function setUpdatedAt(string $value): ImsWebapiInterface;

/**
* Get last check time
*
* @return string|null
*/
public function getLastCheckTime(): ?string;

/**
* Set last check time
*
* @param string $value
* @return $this
*/
public function setLastCheckTime(string $value): ImsWebapiInterface;

/**
* Get expires time of token
*
* @return string|null
*/
public function getAccessTokenExpiresAt(): ?string;

/**
* Set expires time of token
*
* @param string $value
* @return $this
*/
public function setAccessTokenExpiresAt(string $value): ImsWebapiInterface;

/**
* Retrieve existing extension attributes object or create a new one.
*
* @return \Magento\AdminAdobeIms\Api\Data\ImsWebapiExtensionInterface|null
*/
public function getExtensionAttributes(): ImsWebapiExtensionInterface;

/**
* Set extension attributes
*
* @param \Magento\AdminAdobeIms\Api\Data\ImsWebapiExtensionInterface $extensionAttributes
* @return $this
*/
public function setExtensionAttributes(ImsWebapiExtensionInterface $extensionAttributes): ImsWebapiInterface;
}
35 changes: 35 additions & 0 deletions AdminAdobeIms/Api/Data/ImsWebapiSearchResultsInterface.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/

declare(strict_types=1);

namespace Magento\AdminAdobeIms\Api\Data;

use Magento\AdminAdobeIms\Api\Data\ImsWebapiInterface;
use Magento\Framework\Api\SearchResultsInterface;

/**
* Interface ImsWebapiSearchResultsInterface
*
* @api
*/
interface ImsWebapiSearchResultsInterface extends SearchResultsInterface
{
/**
* Get ims token list.
*
* @return ImsWebapiInterface[]
*/
public function getItems();

/**
* Set ims token list.
*
* @param ImsWebapiInterface[] $items
* @return $this
*/
public function setItems(array $items);
}
25 changes: 25 additions & 0 deletions AdminAdobeIms/Api/ImsLogOutInterface.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/

declare(strict_types=1);

namespace Magento\AdminAdobeIms\Api;

/**
* Declare functionality for user logout from the Adobe IMS account
*
* @api
*/
interface ImsLogOutInterface
{
/**
* LogOut User from Adobe IMS Account
*
* @param string|null $accessToken
* @return bool
*/
public function execute(?string $accessToken = null) : bool;
}
Loading

0 comments on commit 247bdd2

Please sign in to comment.