Merge pull request #19 from alozytskyi/feature/inventory

Support InventoryItem and InventoryLevel

Author: tareqtms

README.md

@@ -254,6 +254,8 @@ Some resources are available directly, some resources are only available through
 - [Event](https://help.shopify.com/api/reference/event/)
 - [FulfillmentService](https://help.shopify.com/api/reference/fulfillmentservice)
 - [GiftCard](https://help.shopify.com/api/reference/gift_card) _(Shopify Plus Only)_
+- [InventoryItem](https://help.shopify.com/api/reference/inventoryitem)
+- [InventoryLevel](https://help.shopify.com/api/reference/inventorylevel)
 - [Location](https://help.shopify.com/api/reference/location/) _(read only)_
 - [Metafield](https://help.shopify.com/api/reference/metafield)
 - [Multipass](https://help.shopify.com/api/reference/multipass) _(Shopify Plus Only, API not available yet)_
@@ -358,6 +360,14 @@ The custom methods are specific to some resources which may not be available for
     - [search()](https://help.shopify.com/api/reference/gift_card#search)
     Search for gift cards matching supplied query
 
+- InventoryLevel ->
+    - [adjust($data)](https://help.shopify.com/api/reference/inventorylevel#adjust)
+    Adjust inventory level.
+    - [connect($data)](https://help.shopify.com/api/reference/inventorylevel#connect)
+    Connect an inventory item to a location.
+    - [set($data)](https://help.shopify.com/api/reference/inventorylevel#set)
+    Set an inventory level for a single inventory item within a location.
+    
 - Order ->
     - [close()](https://help.shopify.com/api/reference/order#close)
     Close an Order

lib/HttpRequestJson.php

@@ -139,4 +139,4 @@ protected static function processResponse($response)
         return json_decode($response, true);
     }
 
-}
+}

lib/InventoryItem.php

@@ -0,0 +1,15 @@
+<?php
+/**
+ * @author Arsenii Lozytskyi <[email protected]>
+ * Created at 04/15/18 02:25 PM UTC+03:00
+ *
+ * @see https://help.shopify.com/api/reference/inventoryitem
+ */
+
+namespace PHPShopify;
+
+class InventoryItem extends ShopifyResource
+{
+    /** @inheritDoc */
+    protected $resourceKey = 'inventory_item';
+}

lib/InventoryLevel.php

@@ -0,0 +1,35 @@
+<?php
+/**
+ * @author Arsenii Lozytskyi <[email protected]>
+ * Created at 04/15/18 02:31 PM UTC+03:00
+ *
+ * @see https://help.shopify.com/api/reference/inventorylevel
+ */
+
+namespace PHPShopify;
+
+/**
+ * Class InventoryLevel
+ *
+ * @method array adjust($data)  Adjust inventory level.
+ * @method array connect($data) Connect an inventory item to a location.
+ * @method array set($data)     Sets an inventory level for a single inventory item within a location.
+ */
+class InventoryLevel extends ShopifyResource
+{
+    /** @inheritDoc */
+    protected $resourceKey = 'inventory_level';
+
+    /** @inheritDoc */
+    protected $customPostActions = [
+        'adjust',
+        'connect',
+        'set',
+    ];
+
+    protected $customPostActionsNoWrap = [
+        'adjust',
+        'connect',
+        'set',
+    ];
+}

lib/ShopifyResource.php

@@ -48,7 +48,7 @@ abstract class ShopifyResource
 
     /**
      * List of child Resource names / classes
-     * 
+     *
      * If any array item has an associative key => value pair, value will be considered as the resource name
      * (by which it will be called) and key will be the associated class name.
      *
@@ -96,6 +96,16 @@ abstract class ShopifyResource
     protected $customPutActions = array();
     protected $customDeleteActions = array();
 
+    /**
+     * Some actions from inventory levels do not wrap the content of the request
+     *
+     * Wrapping such request body leads to errors. This list is used to disable this wrapping
+     * on certain methods.
+     *
+     * @var array
+     */
+    protected $customPostActionsNoWrap = array();
+
     /**
      * The ID of the resource
      *
@@ -225,7 +235,7 @@ public function __call($name, $arguments)
 
             $url = $this->generateUrl($urlParams, $customAction);
 
-            return $this->$httpMethod($dataArray, $url);
+            return $this->$httpMethod($dataArray, $url, !in_array($name, $this->customPostActionsNoWrap));
         }
     }
 
@@ -355,18 +365,22 @@ public function search($query)
     /**
      * Call POST method to create a new resource
      *
-     * @param array $dataArray Check Shopify API reference of the specific resource for the list of required and optional data elements to be provided
+     * @param array  $dataArray Check Shopify API reference of the specific resource for the list of required and optional data elements to be provided
      * @param string $url
      *
-     * @uses HttpRequestJson::post() to send the HTTP request
+     * @param bool   $wrapBody
      *
      * @return array
+     * @throws ApiException
+     * @throws CurlException
+     * @uses HttpRequestJson::post() to send the HTTP request
+     *
      */
-    public function post($dataArray, $url = null)
+    public function post($dataArray, $url = null, $wrapBody = true)
     {
         if (!$url) $url = $this->generateUrl();
 
-        if (!empty($dataArray)) $dataArray = $this->wrapData($dataArray);
+        if ($wrapBody && !empty($dataArray)) $dataArray = $this->wrapData($dataArray);
 
         $response = HttpRequestJson::post($url, $dataArray, $this->httpHeaders);
 
@@ -498,4 +512,4 @@ public function processResponse($responseArray, $dataKey = null)
             return $responseArray;
         }
     }
-}
+}

lib/ShopifySDK.php

@@ -102,6 +102,8 @@ class ShopifySDK
         'Event',
         'FulfillmentService',
         'GiftCard',
+        'InventoryItem',
+        'InventoryLevel',
         'Location',
         'Metafield',
         'Multipass',
@@ -296,4 +298,4 @@ public static function checkApiCallLimit($firstCallWait = false)
 
         static::$microtimeOfLastApiCall = microtime(true);
     }
-}
+}