Merge pull request #9 from ohmybrew/v3-dev

V3

Author: gnikyt

CHANGELOG.md

@@ -1,5 +1,17 @@
 # CHANGELOG
 
+# Version 3.0.0
+
+*Contains breaking changes*
+
+To better the library, it has been reverted back to its original single-class form and backwards compatibile with 1.x.x
+
++ GraphQL and REST are all under one class
++ `getApiCalls()` now takes two arguments, first being rest|graph, second being the key
++ `rest()` is now for REST calls
++ `graph()` is now for GraphQL calls
++ `request()` is aliased to `rest()` for backward compatibility
+
 # Version 2.0.0
 
 *Contains breaking changes*

README.md

@@ -17,78 +17,44 @@ The recommended way to install is [through composer](http://packagist.org).
 
 ## Usage
 
+Add `use OhMyBrew\BasicShopifyAPI;` to your imports.
+
 ### Public API
 
-For OAuth applications. The shop domain, API key, API secret, and an access token are required. This assumes you properly have your app setup in the partner's dashboard with the correct keys and redirect URIs.
+This assumes you properly have your app setup in the partner's dashboard with the correct keys and redirect URIs.
 
-#### Quick run-down
+#### REST
 
-##### REST Method
+For REST calls, the shop domain and access token are required.
 
 ```php
-use OhMyBrew\ShopifyAPI;
-
-$api = new RestAPI;
-$api->setApiKey('your key here');
-$api->setApiSecret('your secret here');
+$api = new BasicShopifyAPI();
+$api->setShop('your shop here');
+$api->setAccessToken('your token here');
 
-$api->setShop('example.myshopify.com');
-$api->setAccessToken('a token here');
-// or
-$api->setSession('example.myshopify.com', 'a token here');
-
-/**
- * $request will return an object with keys of `response` for full Guzzle response
- * `body` with JSON-decoded result
- */
-$request = $api->request('GET', '/admin/shop.json');
-echo $request->response->getStatusCode();
-echo $request->body->shop->name;
+// Now run your requests...
+$api->rest(...);
 ```
 
-##### GraphQL Method
+#### GraphQL
 
-```php
-use OhMyBrew\ShopifyAPI;
+For GraphQL calls, the shop domain and access token are required.
 
-$api = new GraphAPI;
-$api->setApiKey('your key here');
-$api->setApiSecret('your secret here');
+```php
+$api = new BasicShopifyAPI();
+$api->setShop('your shop here');
+$api->setAccessToken('your token here');
 
-$api->setShop('example.myshopify.com');
-$api->setAccessToken('a token here');
-// or
-$api->setSession('example.myshopify.com', 'a token here');
-
-/**
- * $request will return an object with keys of `response` for full Guzzle response
- * `body` with JSON-decoded result
- */
-$query =<<<QL
-{
-    shop {
-        products(first: 2) {
-            edges {
-                node {
-                    id
-                    handle
-                }
-            }
-        }
-    }
-}
-QL;
-$request = $api->request($query);
-echo $request->response->getStatusCode();
-echo $request->body->shop->products->edges[0]->node->handle;
+// Now run your requests...
+$api->graph(...);
 ```
 
 #### Getting access token
 
 After obtaining the user's shop domain, to then direct them to the auth screen use `getAuthUrl`, as example (basic PHP):
 
 ```php
-$api = new RestAPI; // or GraphAPI
+$api = new BasicShopifyAPI();
 $api->setShop($_SESSION['shop']);
 $api->setApiKey(env('SHOPIFY_API_KEY'));
 
@@ -110,7 +76,7 @@ if (!$code) {
   $api->setAccessToken($token);
 
   // You can now make API calls as well once you've set the token to `setAccessToken`
-  $request = $api->request('GET', '/admin/shop.json');
+  $request = $api->rest('GET', '/admin/shop.json'); // or GraphQL
 }
 ```
 
@@ -125,65 +91,43 @@ $valid = $api->verifyRequest($_GET);
 
 ### Private API
 
-For private application calls. The shop domain, API key, and API password are required.
+This assumes you properly have your app setup in the partner's dashboard with the correct keys and redirect URIs.
 
-#### Quick run-down
+#### REST
 
-##### REST Method
+For REST calls, shop domain, API key, and API password are request
 
 ```php
-$api = new RestAPI(true); // true sets it to private
+$api = new BasicShopifyAPI(true); // true sets it to private
 $api->setShop('example.myshopify.com');
 $api->setApiKey('your key here');
 $api->setApiPassword('your password here');
 
-/**
- * $request will return an object with keys of `response` for full Guzzle response
- * `body` with JSON-decoded result
- */
-$request = $api->request('GET', '/admin/shop.json');
-echo $request->response->getStatusCode();
-echo $request->body->shop->name;
+// Now run your requests...
+$api->rest(...);
 ```
 
-##### GraphQL Method
+#### GraphQL
+
+For GraphQL calls, shop domain and API password are required.
 
 ```php
-$api = new GraphAPI(true); // true sets it to private
+$api = new BasicShopifyAPI(true); // true sets it to private
 $api->setShop('example.myshopify.com');
-$api->setApiPassword('your password here'); // This is used as the access token for GraphQL
-
-/**
- * $request will return an object with keys of `response` for full Guzzle response
- * `body` with JSON-decoded result
- */
-$query =<<<QL
-{
-    shop {
-        products(first: 2) {
-            edges {
-                node {
-                    id
-                    handle
-                }
-            }
-        }
-    }
-}
-QL;
-$request = $api->request($query);
-echo $request->response->getStatusCode();
-echo $request->body->shop->products->edges[0]->node->handle;
+$api->setApiPassword('your password here');
+
+// Now run your requests...
+$api->graph(...);
 ```
 
 ### Making requests
 
-#### REST Method
+#### REST
 
 Requests are made using Guzzle.
 
 ```php
-$api->request(string $type, string $path, array $params = null);
+$api->rest(string $type, string $path, array $params = null);
 ```
 
 + `type` refers to GET, POST, PUT, DELETE, etc
@@ -195,12 +139,14 @@ The return value for the request will be an object containing:
 + `response` the full Guzzle response object
 + `body` the JSON decoded response body
 
-#### GraphQL Method
+*Note*: `request()` will alias to `rest()` as well.
+
+#### GraphQL
 
 Requests are made using Guzzle.
 
 ```php
-$api->request(string $query);
+$api->graph(string $query);
 ```
 
 + `query` refers to the full GraphQL query
@@ -217,7 +163,7 @@ After each request is made, the API call limits are updated. To access them, sim
 ```php
 // Returns an array of left, made, and limit.
 // Example: ['left' => 79, 'made' => 1, 'limit' => 80]
-$limits = $api->getApiCalls();
+$limits = $api->getApiCalls('rest'); // or 'graph'
 ```
 
 For GraphQL, additionally there will be the following values: `restoreRate`, `requestedCost`, `actualCost`.
@@ -227,9 +173,9 @@ To quickly get a value, you may pass an optional parameter to the `getApiCalls`
 ```php
 // As example, this will return 79
 // You may pass 'left', 'made', or 'limit'
-$left = $api->getApiCalls('left'); // returns 79
+$left = $api->getApiCalls('graph', 'left'); // returns 79
 // or
-$left = $api->getApiCalls()['left']; // returns 79
+$left = $api->getApiCalls('graph')['left']; // returns 79
 ```
 
 ### Isolated API calls
@@ -247,17 +193,17 @@ $api->withSession(string $shop, string $accessToken, Closure $closure);
 `$this` will be binded to the current API. Example:
 
 ```php
-$api = new RestAPI(true);
+$api = new BasicShopifyAPI(true);
 $api->setApiKey('your key here');
 $api->setApiPassword('your password here');
 
 $api->withSession('some-shop.myshopify.com', 'token from database?', function() {
-  $request = $this->request('GET', '/admin/shop.json');
+  $request = $this->rest('GET', '/admin/shop.json');
   echo $request->body->shop->name; // Some Shop
 });
 
 $api->withSession('some-shop-two.myshopify.com', 'token from database?', function() {
-  $request = $this->request('GET', '/admin/shop.json');
+  $request = $this->rest('GET', '/admin/shop.json');
   echo $request->body->shop->name; // Some Shop Two
 });
 ```

UPGRADING.md

@@ -1,24 +1,19 @@
 # Upgrading
 
-# v1.x.x -> v2.0.0
+# v1.x.x -> v3.0.0
 
-Library is no longer a single class. It now has a namespace with several classes.
++ `getApiCalls()` now takes two arguments, first being rest|graph, second being the key
 
 Old:
 
 ```php
-use OhMyBrew\BasicShopifyAPI;
-
-$api = new BasicShopifyAPI(...);
+getApiCalls('left');
 ```
 
 New:
 
 ```php
-
-use OhMyBrew\ShopifyAPI;
-
-$api = new RestAPI(...);
+getApiCalls('rest', 'left');
 ```
 
-A GraphQL API class is now also included, use `GraphAPI`.
++ `request()` still exists, and is aliased to `rest()` but encourage you to move all REST calls to the new `rest()` method name

composer.json

@@ -21,7 +21,7 @@
     "squizlabs/php_codesniffer": "^3.0"
   },
   "autoload": {
-    "psr-4": { "OhMyBrew\\ShopifyAPI\\": "src/OhMyBrew/ShopifyAPI/" }
+    "files": ["src/OhMyBrew/BasicShopifyAPI.php"]
   },
   "config": { "bin-dir": "bin" }
 }