From fe8cc058dbc617ab9c5b3e181a599d923e0f7e06 Mon Sep 17 00:00:00 2001 From: Vitaliy Boyko Date: Mon, 11 Feb 2019 21:05:32 +0200 Subject: [PATCH 1/4] graphQl-292: payment method list --- .../AvailablePaymentMethodsDataProvider.php | 53 +++++++++++++++++++ .../AvailablePaymentMethodsResolver.php | 48 +++++++++++++++++ .../Magento/QuoteGraphQl/etc/schema.graphqls | 6 +++ 3 files changed, 107 insertions(+) create mode 100644 app/code/Magento/QuoteGraphQl/Model/Cart/PaymentMethod/AvailablePaymentMethodsDataProvider.php create mode 100644 app/code/Magento/QuoteGraphQl/Model/Resolver/AvailablePaymentMethodsResolver.php diff --git a/app/code/Magento/QuoteGraphQl/Model/Cart/PaymentMethod/AvailablePaymentMethodsDataProvider.php b/app/code/Magento/QuoteGraphQl/Model/Cart/PaymentMethod/AvailablePaymentMethodsDataProvider.php new file mode 100644 index 0000000000000..daa51d8729995 --- /dev/null +++ b/app/code/Magento/QuoteGraphQl/Model/Cart/PaymentMethod/AvailablePaymentMethodsDataProvider.php @@ -0,0 +1,53 @@ +informationManagement = $informationManagement; + } + + /** + * Collect and return information about available payment methods + * + * @param CartInterface $cart + * @return array + */ + public function getPaymentMethods(CartInterface $cart): array + { + $paymentInformation = $this->informationManagement->getPaymentInformation($cart->getId()); + $paymentMethods = $paymentInformation->getPaymentMethods(); + + $paymentMethodsNested = []; + foreach ($paymentMethods as $paymentMethod) { + $paymentMethodsNested[] = [ + 'title' => $paymentMethod->getTitle(), + 'code' => $paymentMethod->getCode() + ]; + } + + return $paymentMethodsNested; + } +} diff --git a/app/code/Magento/QuoteGraphQl/Model/Resolver/AvailablePaymentMethodsResolver.php b/app/code/Magento/QuoteGraphQl/Model/Resolver/AvailablePaymentMethodsResolver.php new file mode 100644 index 0000000000000..17747ec11b25a --- /dev/null +++ b/app/code/Magento/QuoteGraphQl/Model/Resolver/AvailablePaymentMethodsResolver.php @@ -0,0 +1,48 @@ +addressDataProvider = $addressDataProvider; + } + + /** + * @inheritdoc + */ + public function resolve(Field $field, $context, ResolveInfo $info, array $value = null, array $args = null) + { + if (!isset($value['model'])) { + throw new LocalizedException(__('"model" value should be specified')); + } + + $cart = $value['model']; + + return $this->addressDataProvider->getPaymentMethods($cart); + } +} diff --git a/app/code/Magento/QuoteGraphQl/etc/schema.graphqls b/app/code/Magento/QuoteGraphQl/etc/schema.graphqls index 4c1101a5f90a8..072810de0bb47 100644 --- a/app/code/Magento/QuoteGraphQl/etc/schema.graphqls +++ b/app/code/Magento/QuoteGraphQl/etc/schema.graphqls @@ -98,6 +98,7 @@ type Cart { items: [CartItemInterface] applied_coupon: AppliedCoupon addresses: [CartAddress]! @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CartAddresses") + available_payment_methods : [CheckoutPaymentMethod] @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\AvailablePaymentMethodsResolver") @doc(description: "Available payment methods") } type CartAddress { @@ -141,6 +142,11 @@ type CheckoutShippingMethod { # TODO: Add more complex structure for shipping rates } +type CheckoutPaymentMethod @doc(description: "The type contains list of active payment methods") { + code : String @doc(description: "The payment method code") + title : String @doc(description: "The payment method title.") +} + enum AdressTypeEnum { SHIPPING BILLING From 3c8ac9b608a98420f7ea271cbca7e84b2a70f509 Mon Sep 17 00:00:00 2001 From: Valerii Naida Date: Tue, 19 Feb 2019 17:03:50 -0600 Subject: [PATCH 2/4] GraphQL-292: [Payment methods] Get list of available payment methods for current cart --- .../AvailablePaymentMethods.php} | 35 ++++++++++---- .../AvailablePaymentMethodsResolver.php | 48 ------------------- .../Magento/QuoteGraphQl/etc/schema.graphqls | 2 +- 3 files changed, 26 insertions(+), 59 deletions(-) rename app/code/Magento/QuoteGraphQl/Model/{Cart/PaymentMethod/AvailablePaymentMethodsDataProvider.php => Resolver/AvailablePaymentMethods.php} (52%) delete mode 100644 app/code/Magento/QuoteGraphQl/Model/Resolver/AvailablePaymentMethodsResolver.php diff --git a/app/code/Magento/QuoteGraphQl/Model/Cart/PaymentMethod/AvailablePaymentMethodsDataProvider.php b/app/code/Magento/QuoteGraphQl/Model/Resolver/AvailablePaymentMethods.php similarity index 52% rename from app/code/Magento/QuoteGraphQl/Model/Cart/PaymentMethod/AvailablePaymentMethodsDataProvider.php rename to app/code/Magento/QuoteGraphQl/Model/Resolver/AvailablePaymentMethods.php index daa51d8729995..907d778550593 100644 --- a/app/code/Magento/QuoteGraphQl/Model/Cart/PaymentMethod/AvailablePaymentMethodsDataProvider.php +++ b/app/code/Magento/QuoteGraphQl/Model/Resolver/AvailablePaymentMethods.php @@ -5,15 +5,19 @@ */ declare(strict_types=1); -namespace Magento\QuoteGraphQl\Model\Cart\PaymentMethod; +namespace Magento\QuoteGraphQl\Model\Resolver; use Magento\Checkout\Api\PaymentInformationManagementInterface; +use Magento\Framework\Exception\LocalizedException; +use Magento\Framework\GraphQl\Config\Element\Field; +use Magento\Framework\GraphQl\Query\ResolverInterface; +use Magento\Framework\GraphQl\Schema\Type\ResolveInfo; use Magento\Quote\Api\Data\CartInterface; /** - * Get array of available payment methods. + * Get list of active payment methods resolver. */ -class AvailablePaymentMethodsDataProvider +class AvailablePaymentMethods implements ResolverInterface { /** * @var PaymentInformationManagementInterface @@ -21,7 +25,6 @@ class AvailablePaymentMethodsDataProvider private $informationManagement; /** - * AvailablePaymentMethodsDataProvider constructor. * @param PaymentInformationManagementInterface $informationManagement */ public function __construct(PaymentInformationManagementInterface $informationManagement) @@ -29,25 +32,37 @@ public function __construct(PaymentInformationManagementInterface $informationMa $this->informationManagement = $informationManagement; } + /** + * @inheritdoc + */ + public function resolve(Field $field, $context, ResolveInfo $info, array $value = null, array $args = null) + { + if (!isset($value['model'])) { + throw new LocalizedException(__('"model" value should be specified')); + } + + $cart = $value['model']; + return $this->getPaymentMethodsData($cart); + } + /** * Collect and return information about available payment methods * * @param CartInterface $cart * @return array */ - public function getPaymentMethods(CartInterface $cart): array + private function getPaymentMethodsData(CartInterface $cart): array { $paymentInformation = $this->informationManagement->getPaymentInformation($cart->getId()); $paymentMethods = $paymentInformation->getPaymentMethods(); - $paymentMethodsNested = []; + $paymentMethodsData = []; foreach ($paymentMethods as $paymentMethod) { - $paymentMethodsNested[] = [ + $paymentMethodsData[] = [ 'title' => $paymentMethod->getTitle(), - 'code' => $paymentMethod->getCode() + 'code' => $paymentMethod->getCode(), ]; } - - return $paymentMethodsNested; + return $paymentMethodsData; } } diff --git a/app/code/Magento/QuoteGraphQl/Model/Resolver/AvailablePaymentMethodsResolver.php b/app/code/Magento/QuoteGraphQl/Model/Resolver/AvailablePaymentMethodsResolver.php deleted file mode 100644 index 17747ec11b25a..0000000000000 --- a/app/code/Magento/QuoteGraphQl/Model/Resolver/AvailablePaymentMethodsResolver.php +++ /dev/null @@ -1,48 +0,0 @@ -addressDataProvider = $addressDataProvider; - } - - /** - * @inheritdoc - */ - public function resolve(Field $field, $context, ResolveInfo $info, array $value = null, array $args = null) - { - if (!isset($value['model'])) { - throw new LocalizedException(__('"model" value should be specified')); - } - - $cart = $value['model']; - - return $this->addressDataProvider->getPaymentMethods($cart); - } -} diff --git a/app/code/Magento/QuoteGraphQl/etc/schema.graphqls b/app/code/Magento/QuoteGraphQl/etc/schema.graphqls index a505b87ccbae9..bab85f26b8b1e 100644 --- a/app/code/Magento/QuoteGraphQl/etc/schema.graphqls +++ b/app/code/Magento/QuoteGraphQl/etc/schema.graphqls @@ -104,7 +104,7 @@ type Cart { applied_coupon: AppliedCoupon shipping_addresses: [CartAddress]! @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\ShippingAddresses") billing_address: CartAddress! @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\BillingAddress") - available_payment_methods : [CheckoutPaymentMethod] @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\AvailablePaymentMethodsResolver") @doc(description: "Available payment methods") + available_payment_methods : [CheckoutPaymentMethod] @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\AvailablePaymentMethods") @doc(description: "Available payment methods") } type CartAddress { From fd114ecfbee9900e9abf8d6dfd8b14137c1ccad9 Mon Sep 17 00:00:00 2001 From: Valerii Naida Date: Tue, 19 Feb 2019 17:06:20 -0600 Subject: [PATCH 3/4] GraphQL-292: [Payment methods] Get list of available payment methods for current cart --- app/code/Magento/QuoteGraphQl/etc/schema.graphqls | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/app/code/Magento/QuoteGraphQl/etc/schema.graphqls b/app/code/Magento/QuoteGraphQl/etc/schema.graphqls index bab85f26b8b1e..5749f830c1edc 100644 --- a/app/code/Magento/QuoteGraphQl/etc/schema.graphqls +++ b/app/code/Magento/QuoteGraphQl/etc/schema.graphqls @@ -104,7 +104,7 @@ type Cart { applied_coupon: AppliedCoupon shipping_addresses: [CartAddress]! @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\ShippingAddresses") billing_address: CartAddress! @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\BillingAddress") - available_payment_methods : [CheckoutPaymentMethod] @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\AvailablePaymentMethods") @doc(description: "Available payment methods") + available_payment_methods : [PaymentMethod] @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\AvailablePaymentMethods") @doc(description: "Available payment methods") } type CartAddress { @@ -156,9 +156,9 @@ type AvailableShippingMethod { price_incl_tax: Float! } -type CheckoutPaymentMethod @doc(description: "The type contains list of active payment methods") { - code : String @doc(description: "The payment method code") - title : String @doc(description: "The payment method title.") +type PaymentMethod { + code: String @doc(description: "The payment method code") + title: String @doc(description: "The payment method title.") } enum AdressTypeEnum { From 7c42d2afd9ca4d182d473b95dd2b4afe1c0152cc Mon Sep 17 00:00:00 2001 From: Vitaliy Boyko Date: Wed, 20 Feb 2019 11:09:27 +0200 Subject: [PATCH 4/4] graphQl-292: added test coverage for payment methods --- .../Quote/GetAvailablePaymentMethodsTest.php | 152 ++++++++++++++++++ 1 file changed, 152 insertions(+) create mode 100644 dev/tests/api-functional/testsuite/Magento/GraphQl/Quote/GetAvailablePaymentMethodsTest.php diff --git a/dev/tests/api-functional/testsuite/Magento/GraphQl/Quote/GetAvailablePaymentMethodsTest.php b/dev/tests/api-functional/testsuite/Magento/GraphQl/Quote/GetAvailablePaymentMethodsTest.php new file mode 100644 index 0000000000000..d6eff6816b342 --- /dev/null +++ b/dev/tests/api-functional/testsuite/Magento/GraphQl/Quote/GetAvailablePaymentMethodsTest.php @@ -0,0 +1,152 @@ +quoteResource = $objectManager->create(QuoteResource::class); + $this->quote = $objectManager->create(Quote::class); + $this->quoteIdToMaskedId = $objectManager->create(QuoteIdToMaskedQuoteIdInterface::class); + $this->customerTokenService = $objectManager->get(CustomerTokenServiceInterface::class); + } + + /** + * @magentoApiDataFixture Magento/Checkout/_files/quote_with_items_saved.php + */ + public function testGetCartWithPaymentMethodsForRegisteredCustomer() + { + $reservedOrderId = 'test_order_item_with_items'; + $this->quoteResource->load( + $this->quote, + $reservedOrderId, + 'reserved_order_id' + ); + + $maskedQuoteId = $this->quoteIdToMaskedId->execute((int)$this->quote->getId()); + $query = $this->prepareGetCartQuery($maskedQuoteId); + + $response = $this->sendRequestWithToken($query); + + self::assertArrayHasKey('cart', $response); + self::assertNotEmpty($response['cart']['items']); + self::assertNotEmpty($response['cart']['available_payment_methods']); + self::assertCount(1, $response['cart']['available_payment_methods']); + self::assertEquals('checkmo', $response['cart']['available_payment_methods'][0]['code']); + self::assertEquals('Check / Money order', $response['cart']['available_payment_methods'][0]['title']); + } + + /** + * @magentoApiDataFixture Magento/Checkout/_files/active_quote.php + */ + public function testGetCartWithPaymentMethodsForGuest() + { + $reservedOrderId = 'test_order_1'; + $this->quoteResource->load( + $this->quote, + $reservedOrderId, + 'reserved_order_id' + ); + + $maskedQuoteId = $this->quoteIdToMaskedId->execute((int)$this->quote->getId()); + $query = $this->prepareGetCartQuery($maskedQuoteId); + + $response = $this->graphQlQuery($query); + + self::assertArrayHasKey('cart', $response); + + self::assertNotEmpty($response['cart']['available_payment_methods']); + self::assertCount(2, $response['cart']['available_payment_methods']); + self::assertEquals('checkmo', $response['cart']['available_payment_methods'][0]['code']); + self::assertEquals('Check / Money order', $response['cart']['available_payment_methods'][0]['title']); + self::assertEquals('free', $response['cart']['available_payment_methods'][1]['code']); + self::assertEquals( + 'No Payment Information Required', + $response['cart']['available_payment_methods'][1]['title'] + ); + } + + /** + * Generates query for setting the specified shipping method on cart + * + * @param string $maskedQuoteId + * @return string + */ + private function prepareGetCartQuery( + string $maskedQuoteId + ) : string { + return <<customerTokenService->createCustomerAccessToken('customer@example.com', 'password'); + $headerMap = ['Authorization' => 'Bearer ' . $customerToken]; + + return $this->graphQlQuery($query, [], '', $headerMap); + } +}