Merge remote-tracking branch 'upstream/master'

Author: gersanco

CHANGELOG.md

@@ -1,7 +1,61 @@
+### v0.6.0.pre
+
+* bug-fixes
+  * Fix `Carts#create` method
+  * Fix `Carts#set_shipping_method_to_default` method
+  * Fix `OrderSettings#update` method
+  * Fix `Orders#capture_payment_process` method
+  * Fix `Orders#create_cancelation_process` method
+  * Fix `Products#attachments` method
+  * Fix `Products#adjust_stock_level` method
+  * Fix `Products#add_image` method
+  * Fix `Products#set_image_as_default` method
+  * Fix `ProductsView#all` method
+  * Fix `Shops#legal_content` method
+  * Fix `Shops#legal_contents` method
+  * Fix `Shops#update` method
+  * Fix `Users#verify_password` method
+
+* deprecations
+  * Remove `Orders#send_invoice` method
+  * Remove all product_settings methods
+  * Remove `ProductsView#search_by_query` method
+  * `Orders#update_order_note` receives parameter `order_note` instead of `body`
+  * `Products#adjust_stock_level` receives parameter `relative_amount` instead of `body`
+  * `Products#update_reserve_stock` receives parameter `stock_threshold` instead of `body`
+
+* features
+  * Add customers methods
+    * `Customers#all`
+    * `Customers#create`
+    * `Customers#delete`
+    * `Customers#find`
+    * `Customers#update`
+  * Add `Orders#send_order_document` method
+  * Add products cross-sells methods
+    * `ProductCrossSells#create_cross_sell`
+    * `ProductCrossSells#cross_sell`
+    * `ProductCrossSells#cross_sells`
+    * `ProductCrossSells#delete_cross_sell`
+    * `ProductCrossSells#update_cross_sell`
+  * Add products videos methods
+    * `ProductVideos#add_video`
+    * `ProductVideos#delete_video`
+    * `ProductVideos#update_video`
+    * `ProductVideos#video`
+    * `ProductVideos#videos`
+  * Add `Products#sort_images` method
+  * Add variation images methods
+    * `VariationImages#add_image`
+    * `VariationImages#delete_image`
+    * `VariationImages#image`
+    * `VariationImages#images`
+    * `VariationImages#upload_image`
+
 ### v0.5.1.pre
 
 * bug-fixes
-  * Fix `adjust_stock_level` method
+  * Fix `Products#adjust_stock_level` method
 
 ### v0.5.0.pre
 
@@ -16,8 +70,8 @@
 ### v0.4.0.pre
 
 * bug-fixes
-  * Fix product attribute definition `create` method
-  * Fix product attribute definition `delete` method
+  * Fix `ProductAttributeDefinitions#create` method
+  * Fix `ProductAttributeDefinitions#delete` method
   * Fix product custom attribute module name
   * Include `BeyondApi::ProductCustomAttributes` module into `BeyondApi::Products` class
   * Include `BeyondApi::ProductImages` module into `BeyondApi::Products` class

GETTING_STARTED.md

@@ -37,6 +37,8 @@ session.token.refresh
 
 ## Consuming the API
 
+Check the [_rubydoc_ documentation](https://rubydoc.info/github/ePages-de/beyond_api-ruby_client) for more information on the Beyond API Ruby Client.
+
 Here you can find a list with all available methods:
 
 * Carts

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    beyond_api (0.5.1.pre)
+    beyond_api (0.6.0.pre)
       faraday (~> 0.15)
 
 GEM
@@ -13,7 +13,7 @@ GEM
     dotenv (2.7.5)
     faker (2.4.0)
       i18n (~> 1.6.0)
-    faraday (0.17.1)
+    faraday (0.17.3)
       multipart-post (>= 1.2, < 3)
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)
@@ -52,4 +52,4 @@ DEPENDENCIES
   yard (~> 0.9)
 
 BUNDLED WITH
-   2.0.2
+   2.1.0.pre.3

README.md

@@ -1,6 +1,7 @@
 # Beyond API Ruby Client
 
 ![Gem Version](https://img.shields.io/gem/v/beyond_api?label=gem%20version)
+[![Docs](https://img.shields.io/badge/docs-rubydoc-blue)](https://rubydoc.info/github/ePages-de/beyond_api-ruby_client)
 [![Maintainability](https://api.codeclimate.com/v1/badges/1d173fa0b393e8eaf2a2/maintainability)](https://codeclimate.com/github/ePages-de/beyond_api-ruby_client/maintainability)
 ![License](https://img.shields.io/github/license/ePages-de/beyond_api-ruby_client)
 

lib/beyond_api/resources/carts.rb

@@ -43,8 +43,8 @@ def add_line_item(cart_id, body)
     # @example
     #   @cart = session.carts.create
     #
-    def create(body)
-      response, status = BeyondApi::Request.post(@session, "/carts", body)
+    def create
+      response, status = BeyondApi::Request.post(@session, "/carts")
 
       handle_response(response, status)
     end
@@ -202,7 +202,7 @@ def delete_line_item(cart_id, line_item_id)
     # @return true
     #
     # @example
-    #   session.carts.delete_line_item("2fa7dc36-8305-4628-b961-f2c3f7dda47d")
+    #   session.carts.delete_shipping_address("2fa7dc36-8305-4628-b961-f2c3f7dda47d")
     #
     def delete_shipping_address(cart_id)
       response, status = BeyondApi::Request.delete(@session, "/carts/#{cart_id}/shipping-address")
@@ -290,6 +290,7 @@ def payment_methods(cart_id)
     #     "_ref" => "f084553c-ea77-4745-b1bd-71c64c8419fd",
     #     "quantity" => 2
     #   }
+    #
     #   @cart = session.carts.replace_line_item("f73629e5-fecf-4474-9b04-6b2fcd4663c4", "2c9c0f38-0b9e-4fa7-bcbe-960098ff63aa", body)
     #
     def replace_line_item(cart_id, line_item_id, body)
@@ -311,8 +312,13 @@ def replace_line_item(cart_id, line_item_id, body)
     # @return [OpenStruct]
     #
     # @example
-    #   body = [{"_type":"PRODUCT","_ref":"0612362d-9856-4b40-94c6-a36abec0cf8c","quantity":1}]
-    #   @cart = session.carts.replace_line_item("c1436110-e283-49b3-a748-0321efec6d35", body)
+    #   body = [ {
+    #     "_type" => "PRODUCT",
+    #     "_ref" => "0612362d-9856-4b40-94c6-a36abec0cf8c",
+    #     "quantity" => 1 
+    #   } ]
+    #
+    #   @cart = session.carts.replace_line_items("c1436110-e283-49b3-a748-0321efec6d35", body)
     #
     def replace_line_items(cart_id, body)
       response, status = BeyondApi::Request.put(@session, "/carts/#{cart_id}/line-items", body)
@@ -361,6 +367,7 @@ def replace_line_items(cart_id, body)
     #     "taxNumber" => "123-34-6789",
     #     "birthDate" => "1985-03-20"
     #   }
+    #
     #   @cart = session.carts.set_billing_address("01da6aa7-8aa2-4383-a496-6611a14afbc9", body)
     #
     def set_billing_address(cart_id, body)
@@ -453,6 +460,7 @@ def set_payment_method_to_default(cart_id)
     #     "taxNumber" => "123-34-6789",
     #     "birthDate" => "1985-03-20"
     #   }
+    #
     #   @cart = session.carts.set_shipping_address("01da6aa7-8aa2-4383-a496-6611a14afbc9", body)
     #
     def set_shipping_address(cart_id, body)
@@ -489,7 +497,7 @@ def set_shipping_method(cart_id, shipping_zone_id, shipping_method_id)
     # A +PUT+ request is used to set the shipping method to the current default shipping method.
     # The default shipping method is the one with the highest priority of the applicable shipping methods.
     #
-    #   $ curl 'https://api-shop.beyondshop.cloud/api/carts/64efe22b-2699-4032-a2c9-c94a2e4fa425/shipping-methods/default' -i -X PUT \
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/carts/c31c5d06-4460-4f89-9e09-47f9956dea98/shipping-methods/default' -i -X PUT \
     #       -H 'Content-Type: application/json' \
     #       -H 'Accept: application/json'
     #
@@ -498,11 +506,10 @@ def set_shipping_method(cart_id, shipping_zone_id, shipping_method_id)
     # @return [OpenStruct]
     #
     # @example
-    #   @cart = session.carts.set_shipping_method_to_default("a4e7922a-f895-4a7d-8cb1-6ecf74d7ceba")
+    #   @cart = session.carts.set_shipping_method_to_default("c31c5d06-4460-4f89-9e09-47f9956dea98")
     #
     def set_shipping_method_to_default(cart_id)
-      response, status = BeyondApi::Request.put(@session, "/carts/#{cart_id}/shipping-methods/current",
-                                                "#{session.api_url}/shipping-zones/#{shipping_zone_id}/shipping-methods/#{shipping_method_id}")
+      response, status = BeyondApi::Request.put(@session, "/carts/#{cart_id}/shipping-methods/default")
 
       handle_response(response, status)
     end
@@ -523,6 +530,7 @@ def set_shipping_method_to_default(cart_id)
     #
     def shipping_method(cart_id)
       response, status = BeyondApi::Request.get(@session, "/carts/#{cart_id}")
+
       handle_response(response, status)
     end
 
@@ -541,6 +549,7 @@ def shipping_method(cart_id)
     #
     def shipping_methods(cart_id)
       response, status = BeyondApi::Request.get(@session, "/carts/#{cart_id}")
+
       handle_response(response, status)
     end
   end

lib/beyond_api/resources/categories.rb

@@ -96,7 +96,7 @@ def delete(category_id)
     # @return [OpenStruct]
     #
     # @example
-    #   @category = session.categories.find(category_id)
+    #   @category = session.categories.find("27a94b71-9b17-4f06-9596-fbbf4d18021f")
     #
     def find(category_id)
       response, status = BeyondApi::Request.get(@session, "/categories/#{category_id}")
@@ -135,7 +135,7 @@ def patch(category_id, body)
     end
 
     #
-    # A PUT request is issued to update all category properties with application/json content type.
+    # A +PUT+ request is issued to update all category properties with application/json content type.
     #
     #   $ curl 'https://api-shop.beyondshop.cloud/api/categories/cb2058dc-871a-4e64-83ac-39a0be9e6f82' -i -X PUT \
     #       -H 'Content-Type: application/json' \

lib/beyond_api/resources/categories_view.rb

@@ -126,12 +126,23 @@ def search_by_product_id(product_id, params = {})
     #     }
     #   }'
     #
-    # @param product_id [String] the product UUID of the category
+    # @param body [Hash] the request body
+    # @option params [Integer] :size the page size
+    # @option params [Integer] :page the page number
     #
     # @return [OpenStruct]
     #
     # @example
-    #   @category = session.categories_view.search_by_product_id("ba68427f-603c-4741-9185-3b379f7769b5")
+    #   body = {
+    #     "tags" => [ "books" ],
+    #     "manufacturer" => "The Standard Manufacturer",
+    #     "sales_price" => {
+    #       "amount" => 10.0,
+    #       "currency" => "EUR"
+    #     }
+    #   }
+    #
+    #   @categories = session.categories_view.search_by_product(body, { size: 100, page: 0 })
     #
     def search_by_product(body, params = {})
       response, status = BeyondApi::Request.post(@session, "/product-view/categories/search/find-by-product", body, params)

lib/beyond_api/resources/checkout_settings.rb

@@ -32,13 +32,28 @@ def all
     #       -H 'Content-Type: application/json' \
     #       -H 'Accept: application/hal+json' \
     #       -H 'Authorization: Bearer <Access token>' \
-    #       -d ' {
+    #       -d '{
     #       "minimumOrderValue" : {
     #         "currency" : "EUR",
     #         "amount" : 50
     #       },
     #       "mustAcceptTermsAndConditions" : true
     #   }'
+    #
+    # @beyond_api.scopes +cset:u+
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #       "minimum_order_value" => {
+    #         "currency" => "EUR",
+    #         "amount" => 50
+    #       },
+    #       "must_accept_terms_and_conditions" => true
+    #   }
+    #   @checkout_settiongs = session.checkout_settings.update(body)
+    #
     def update(body)
       response, status = BeyondApi::Request.put(@session, "/checkout-settings", body)