Merge pull request #2 from mrt1m/rc-2.0.0

2.0.0 - 2023-04-30

Author: Ishmukhametov Timur

.gitattributes

@@ -1,2 +1,7 @@
 /examples/ export-ignore
-/docker-compose.yaml export-ignore
+/response/ export-ignore
+/postman_collection/ export-ignore
+/docker-compose.yaml export-ignore
+/Dockerfile export-ignore
+/.gitignore export-ignore
+/Makefile export-ignore

.gitignore

@@ -1 +1,3 @@
 /vendor/
+/composer.lock
+/response

Dockerfile

@@ -0,0 +1,10 @@
+FROM php:8.2-zts-alpine3.17
+
+RUN curl -sS https://getcomposer.org/installer | php \
+    && mv composer.phar /usr/local/bin/composer \
+    && composer clear-cache \
+    && composer -V
+
+RUN apk add bash
+
+WORKDIR /app

Makefile

@@ -0,0 +1,40 @@
+.PHONY: build get_catalog_ps4 get_catalog_ps5 ps_plus_deluxe ps_plus_extra ps_plus_essential get_product_by_id get_concept_by_id get_concept_by_product_id run_example
+
+build:
+	docker compose build php\
+	&& docker compose run --rm php composer install -n
+
+get_catalog_ps4:
+	make run_example name=get_catalog_ps4
+
+get_catalog_ps5:
+	make run_example name=get_catalog_ps5
+
+ps_plus_deluxe:
+	make run_example name=ps_plus_deluxe
+
+ps_plus_extra:
+	make run_example name=ps_plus_extra
+
+ps_plus_essential:
+	make run_example name=ps_plus_extra
+
+get_product_by_id:
+	make run_example name=get_product_by_id
+
+get_concept_by_id:
+	make run_example name=get_concept_by_id
+
+get_concept_by_product_id:
+	make run_example name=get_concept_by_product_id
+
+get_pricing_data_by_concept_id:
+	make run_example name=get_pricing_data_by_concept_id
+
+get_add_ons_by_title_id:
+	make run_example name=get_add_ons_by_title_id
+
+run_example:
+	docker compose run --rm php -f examples/${name}.php > response/${name}.json
+
+

README.md

@@ -2,7 +2,7 @@
 
 ## 1. Prerequisites
 
-* PHP 7.4 or later
+* PHP 8.1 or later
 
 ## 2. Installation
 
@@ -17,41 +17,113 @@ composer require mrt1m/playstation-store-api
 Create Client object using the following code:
 
 ```php
+<?php
+declare(strict_types=1);
+
 use PlaystationStoreApi\Client;
-use PlaystationStoreApi\Enum\Region;
-use GuzzleHttp\Client as HttpClient;
+use GuzzleHttp\Client as HTTPClient;
+use PlaystationStoreApi\Enum\CategoryEnum;
+use PlaystationStoreApi\Enum\RegionEnum;
+
+require_once __DIR__ . '/../vendor/autoload.php';
 
-$clientApi = new Client(new Region(Region::UKRAINE_RUSSIAN), new HttpClient());
+const API_URL = 'https://web.np.playstation.com/api/graphql/v1/';
+
+$client = new Client(RegionEnum::UNITED_STATES, new HTTPClient(['base_uri' => API_URL, 'timeout' => 5]));
 ```
 
 ## 4. API Requests
 
-### 4.1. Request product data
+### 4.1. Request product data by id
 
 ```php
-$response = $clientApi->product()->get('EP0001-CUSA12042_00-GAME000000000000');
+use PlaystationStoreApi\Request\RequestProductById;
+
+/**
+ * Example for https://store.playstation.com/en-us/product/UP0001-CUSA09311_00-GAME000000000000
+ */
+$response = $client->get(new RequestProductById('UP0001-CUSA09311_00-GAME000000000000'));
 ```
 
-### 4.2. Request catalog data
+### 4.2. Request concept data by id
 
 ```php
-use PlaystationStoreApi\Query\CatalogProducts;
-use PlaystationStoreApi\Enum\Category;
-use PlaystationStoreApi\ValueObject\Pagination;
+use PlaystationStoreApi\Request\RequestConceptById;
 
-$sha256Hash = '<insert-your-sha256Hash>';
-$query = new CatalogProducts(new Category(Category::PS4_GAMES), $sha256Hash);
-$query->setPagination(new Pagination(10, 0));
+/**
+ Example for https://store.playstation.com/en-us/concept/10002694
+ */
+$response = $client->get(new RequestConceptById('10002694'));
+```
+
+### 4.3. Request catalog data
 
-$response = $clientApi->catalog()->products($query);
+```php
+use PlaystationStoreApi\Request\RequestProductList;
+
+$response = $client->get(RequestProductList::createFromCategory(CategoryEnum::PS5_GAMES));
+```
+
+## 5. Run examples
+
+If you want run [examples](./examples), you need:
+1) Docker and docker compose
+2) Execute make command for example:
+```bash
+make get_add_ons_by_title_id
 ```
+3) Get api response from [response](./response) directory
+
+## 5. About request signing
 
-#### 4.2.1 Get sha256Hash
+For all request you need send sha256Hash. It's request signature.
 
+You can get sha256Hash from browser request:
 1) Open the Network panel and find query to https://web.np.playstation.com/api/graphql/v1/op
 2) Copy the full request URL and use urldecode
 3) sha256Hash is in the extensions parameter, example:
 
 ```
 https://web.np.playstation.com/api/graphql/v1//op?operationName=categoryGridRetrieve&variables={"id":"44d8bb20-653e-431e-8ad0-c0a365f68d2f","pageArgs":{"size":24,"offset":0},"sortBy":{"name":"productReleaseDate","isAscending":false},"filterBy":[],"facetOptions":[]}&extensions={"persistedQuery":{"version":1,"sha256Hash":"9845afc0dbaab4965f6563fffc703f588c8e76792000e8610843b8d3ee9c4c09"}}
 ```
+If default sha256Hash will be blocked, you can replace the base value:
+1) Get new sha256Hash value
+2) Replace the default value in ``PlaystationStoreApi\RequestLocatorService``
+```php
+use PlaystationStoreApi\RequestLocatorService;
+use PlaystationStoreApi\Request\RequestPSPlusTier;
+
+$customRequestLocatorService = RequestLocatorService::default();
+$customRequestLocatorService->set(RequestPSPlusTier::class, 'new sha256Hash value')
+```
+3) Give $customRequestLocatorService to client
+```php
+declare(strict_types=1);
+
+use PlaystationStoreApi\Client;
+use GuzzleHttp\Client as HTTPClient;
+use PlaystationStoreApi\Enum\CategoryEnum;
+use PlaystationStoreApi\Enum\RegionEnum;
+
+const API_URL = 'https://web.np.playstation.com/api/graphql/v1/';
+
+$client = new Client(
+    RegionEnum::UNITED_STATES, 
+    new HTTPClient(['base_uri' => API_URL, 'timeout' => 5]), 
+    $customRequestLocatorService
+);
+```
+
+## 6. Custom request
+
+If you need custom request:
+1) Create new request class then implement ``PlaystationStoreApi\Request\BaseRequest``
+2) Append new request class with sha256Hash to ``PlaystationStoreApi\RequestLocatorService``
+3) Give new RequestLocatorService to client
+4) Execute client ``get`` method with new request
+
+## 7. Postman collection
+
+You can try playstation api with [postman](https://www.postman.com/).
+
+For import collection download [playstation api.postman_collection.json](./postman_collection/playstation%20api.postman_collection.json)

composer.json

@@ -10,14 +10,13 @@
     }
   ],
   "require": {
-    "php": ">=7.4",
-    "myclabs/php-enum": "1.8.0",
-    "guzzlehttp/guzzle": "7.3.0",
-    "ext-json": "*"
+    "ext-json": "*",
+    "php": ">=8.1",
+    "guzzlehttp/guzzle": "7.3.0"
   },
   "autoload": {
     "psr-4": {
       "PlaystationStoreApi\\": "src/"
     }
   }
-}
+}

docker-compose.yaml

@@ -1,7 +1,8 @@
 version: "3.8"
 services:
   php:
-    image: php:7.4.0alpha1-alpine
+    build:
+      context: .
     volumes:
       - ./:/app:z
-    working_dir: /app
+    working_dir: /app

examples/get_add_ons_by_title_id.php

@@ -0,0 +1,20 @@
+<?php
+declare(strict_types=1);
+
+use PlaystationStoreApi\Client;
+use GuzzleHttp\Client as HTTPClient;
+use PlaystationStoreApi\Enum\RegionEnum;
+use PlaystationStoreApi\Request\RequestAddOnsByTitleId;
+
+require_once __DIR__ . '/../vendor/autoload.php';
+
+const API_URL = 'https://web.np.playstation.com/api/graphql/v1/';
+
+$client = new Client(RegionEnum::UNITED_STATES, new HTTPClient(['base_uri' => API_URL, 'timeout' => 5]));
+
+/**
+ * You can find value "npTitleId" param in the product or concept response
+ */
+$result = $client->get(new RequestAddOnsByTitleId('CUSA09311_00'));
+
+echo json_encode($result, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE);

examples/get_catalog_ps4.php

@@ -1,16 +1,18 @@
 <?php
+declare(strict_types=1);
+
+use PlaystationStoreApi\Client;
+use GuzzleHttp\Client as HTTPClient;
+use PlaystationStoreApi\Enum\CategoryEnum;
+use PlaystationStoreApi\Enum\RegionEnum;
+use PlaystationStoreApi\Request\RequestProductList;
 
 require_once __DIR__ . '/../vendor/autoload.php';
 
-use PlaystationStoreApi\Client;
-use PlaystationStoreApi\Enum\Region;
-use GuzzleHttp\Client as HttpClient;
-use PlaystationStoreApi\Query\CatalogProducts;
-use PlaystationStoreApi\Enum\Category;
+const API_URL = 'https://web.np.playstation.com/api/graphql/v1/';
 
-$clientApi = new Client(new Region(Region::UKRAINE_RUSSIAN), new HttpClient());
+$client = new Client(RegionEnum::UNITED_STATES, new HTTPClient(['base_uri' => API_URL, 'timeout' => 5]));
 
-$sha256Hash = '<insert-your-sha256Hash>';
-$result = $clientApi->catalog()->products(new CatalogProducts(new Category(Category::PS4_GAMES), $sha256Hash));
+$result = $client->get(RequestProductList::createFromCategory(CategoryEnum::PS4_GAMES));
 
-var_dump($result);
+echo json_encode($result, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE);

examples/get_catalog_ps5.php

@@ -1,16 +1,18 @@
 <?php
+declare(strict_types=1);
+
+use PlaystationStoreApi\Client;
+use GuzzleHttp\Client as HTTPClient;
+use PlaystationStoreApi\Enum\CategoryEnum;
+use PlaystationStoreApi\Enum\RegionEnum;
+use PlaystationStoreApi\Request\RequestProductList;
 
 require_once __DIR__ . '/../vendor/autoload.php';
 
-use PlaystationStoreApi\Client;
-use PlaystationStoreApi\Enum\Region;
-use GuzzleHttp\Client as HttpClient;
-use PlaystationStoreApi\Query\CatalogProducts;
-use PlaystationStoreApi\Enum\Category;
+const API_URL = 'https://web.np.playstation.com/api/graphql/v1/';
 
-$clientApi = new Client(new Region(Region::UKRAINE_RUSSIAN), new HttpClient());
+$client = new Client(RegionEnum::UNITED_STATES, new HTTPClient(['base_uri' => API_URL, 'timeout' => 5]));
 
-$sha256Hash = '<insert-your-sha256Hash>';
-$result = $clientApi->catalog()->products(new CatalogProducts(new Category(Category::PS5_GAMES), $sha256Hash));
+$result = $client->get(RequestProductList::createFromCategory(CategoryEnum::PS5_GAMES));
 
-var_dump($result);
+echo json_encode($result, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE);