io.sphere.sdk.meta

Class GraphQLDocumentation

java.lang.Object

io.sphere.sdk.meta.GraphQLDocumentation

public final class GraphQLDocumentation
extends Object

Examples for the usage of GraphQL (experimental). Composable Commerce GraphQL endpoint to fetch products by sku and only receive id, version and skus:

import com.fasterxml.jackson.annotation.JsonCreator;

import com.fasterxml.jackson.annotation.JsonProperty;

import com.fasterxml.jackson.core.type.TypeReference;

import com.fasterxml.jackson.databind.JsonNode;

import io.sphere.sdk.client.HttpRequestIntent;

import io.sphere.sdk.client.SphereRequest;

import io.sphere.sdk.http.HttpMethod;

import io.sphere.sdk.http.HttpResponse;

import io.sphere.sdk.json.SphereJsonUtils;

import io.sphere.sdk.models.Base;

import io.sphere.sdk.models.Versioned;

import org.apache.commons.lang3.Validate;

import javax.annotation.Nullable;

import java.util.List;

import static java.util.stream.Collectors.joining;

public class LightweightProduct extends Base implements Versioned<Product>, ProductIdentifiable {
    private final Long version;
    private final String id;
    private final List<String> skus;

    @JsonCreator
    public LightweightProduct(@JsonProperty("id") final String id, @JsonProperty("version") final Long version, @JsonProperty("skus") final List<String> skus) {
        this.id = id;
        this.version = version;
        this.skus = skus;
    }

    @Override
    public String getId() {
        return id;
    }

    public List<String> getSkus() {
        return skus;
    }

    @Override
    public Long getVersion() {
        return version;
    }

    public static SphereRequest<List<LightweightProduct>> requestOfSkus(final List<String> skus) {
        return new LightweightProductsBySku(skus);
    }

    private static class LightweightProductsBySku extends Base implements SphereRequest<List<LightweightProduct>> {
        public static final int MAX = 100;
        private final List<String> skus;

        public LightweightProductsBySku(final List<String> skus) {
            Validate.notEmpty(skus);
            Validate.isTrue(skus.size() <= MAX, "skus are limited to " + MAX + " elements");
            this.skus = skus;
        }

        @Nullable
        @Override
        public List<LightweightProduct> deserialize(final HttpResponse httpResponse) {
            final JsonNode rootJsonNode = SphereJsonUtils.parse(httpResponse.getResponseBody());
            final JsonNode results = rootJsonNode.get("data").get("products").get("results");
            return SphereJsonUtils.readObject(results, new TypeReference<List<LightweightProduct>>() {
            });
        }

        @Override
        public HttpRequestIntent httpRequestIntent() {
            final String queryString = String.format("query ProductBySku($skus: [String!]!) {\n" +
                    "       products(limit: %d, skus: $skus) {\n" +
                    "           results {\n" +
                    "               id\n" +
                    "               version\n" +
                    "               skus\n" +
                    "           }\n" +
                    "       }\n" +
                    "   }", MAX);
            final String body =String.format(
                    "{\n" +
                            "   \"query\": \"%s\",\n" +
                            "   \"variables\": { \"skus\": [%s]}\n" +
                            "}", queryString.replace("\n", "\\n").replace("\"", "\\\""), skus.stream().distinct().collect(joining("\", \"", "\"", "\"")));
            return HttpRequestIntent.of(HttpMethod.POST, "/graphql", body);
        }
    }
}
See the test code.

import io.sphere.sdk.test.IntegrationTest;

import org.junit.Test;

import java.util.HashSet;

import java.util.List;

import java.util.Set;

import java.util.stream.Collectors;

import static io.sphere.sdk.products.ProductFixtures.withProduct;

import static java.util.Arrays.asList;

import static java.util.Collections.singletonList;

import static org.assertj.core.api.Assertions.assertThat;

public class GraphQLIntegrationTest extends IntegrationTest {
    @Test
    public void lightweigthProductsBySku() {
        withProduct(client(), product1 -> {
            withProduct(client(), product2 -> {
                final List<String> skus = asList(product1, product2).stream()
                        .map(product -> product.getMasterData().getStaged().getMasterVariant().getSku())
                        .collect(Collectors.toList());


                final Set<LightweightProduct> actual = new HashSet<>(client().executeBlocking(LightweightProduct.requestOfSkus(skus)));
                final Set<LightweightProduct> expected = asList(product1, product2).stream()
                        .map(product -> {
                            final String sku = product.getMasterData().getStaged().getMasterVariant().getSku();
                            return new LightweightProduct(product.getId(), product.getVersion(), singletonList(sku));
                        })
                        .collect(Collectors.toSet());
                assertThat(actual).isEqualTo(expected);
            });
        });

    }
}
See the test code.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait