Merge remote-tracking branch 'upstream/master'

unabris · unabris · commit c6dd19443f8b · 2020-05-26T16:17:22.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,23 @@
+### v0.11.0.pre
+
+* enhancements
+  * Improve error handling class
+  * Improve `BeyondApi::Error` class
+
+### v0.10.0.pre
+
+* features
+  * Add optional `paginated: false` parameter to `session.categories_view.all(paginated: false)`
+  * Add optional `paginated: false` parameter to `session.categories.all(paginated: false)`
+  * Add optional `paginated: false` parameter to `session.customers.all(paginated: false)`
+  * Add optional `paginated: false` parameter to `session.orders.all(paginated: false)`
+  * Add optional `paginated: false` parameter to `session.payment_methods.all(paginated: false)`
+  * Add optional `paginated: false` parameter to `session.products_view.all(paginated: false)`
+  * Add optional `paginated: false` parameter to `session.script_tags.all(paginated: false)`
+  * Add optional `paginated: false` parameter to `session.shipping_zones.all(paginated: false)`
+  * Add optional `paginated: false` parameter to `session.users.all(paginated: false)`
+  * Add optional `paginated: false` parameter to `session.webhook_subscriptions.all(paginated: false)`
+
 ### v0.9.0.pre
 
 * bug-fixes
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    beyond_api (0.9.0.pre)
+    beyond_api (0.11.0.pre)
       faraday (~> 0.15)
 
 GEM
diff --git a/lib/beyond_api/error.rb b/lib/beyond_api/error.rb
@@ -1,14 +1,17 @@
 # frozen_string_literal: true
 
 module BeyondApi
-  class Error
-    attr_reader :error_id, :details, :message, :trace_id
+  class Error < StandardError
+    attr_reader :error_id, :details, :trace_id, :full_message, :status_code
 
-    def initialize(data)
-      @error_id = data['errorId']
-      @details = data['details']
-      @message = data['message']
-      @trace_id = data['traceId']
+    def initialize(data, status_code = nil)
+      @error_id     = data['errorId']
+      @details      = data['details']
+      @trace_id     = data['traceId']
+      @full_message = data
+      @status_code  = status_code
+
+      super(data['message'])
     end
   end
 end
diff --git a/lib/beyond_api/resources/categories.rb b/lib/beyond_api/resources/categories.rb
@@ -16,6 +16,7 @@ class Categories < Base
     #
     # @beyond_api.scopes +catg:r+
     #
+    # @option params [Boolean] :paginated
     # @option params [Integer] :size the page size
     # @option params [Integer] :page the page number
     #
@@ -25,9 +26,7 @@ class Categories < Base
     #   @categories = session.categories.all(size: 100, page: 0)
     #
     def all(params = {})
-      response, status = BeyondApi::Request.get(@session, "/categories", params)
-
-      handle_response(response, status)
+      handle_all_request("/categories", :categories, params)
     end
 
     #
diff --git a/lib/beyond_api/resources/categories_view.rb b/lib/beyond_api/resources/categories_view.rb
@@ -14,6 +14,7 @@ class CategoriesView < Base
     #       -H 'Accept: application/hal+json'
     #
     #
+    # @option params [Boolean] :paginated
     # @option params [Integer] :size the page size
     # @option params [Integer] :page the page number
     #
@@ -23,9 +24,7 @@ class CategoriesView < Base
     #   @categories = session.categories_view.all(size: 100, page: 0)
     #
     def all(params = {})
-      response, status = BeyondApi::Request.get(@session, "/product-view/categories", params)
-
-      handle_response(response, status)
+      handle_all_request("/product-view/categories", :categories, params)
     end
 
     #
diff --git a/lib/beyond_api/resources/customers.rb b/lib/beyond_api/resources/customers.rb
@@ -14,6 +14,7 @@ class Customers < Base
     #
     # @beyond_api.scopes +cust:r+
     #
+    # @option params [Boolean] :paginated
     # @option params [Integer] :size the page size
     # @option params [Integer] :page the page number
     #
@@ -23,9 +24,7 @@ class Customers < Base
     #   @customers = session.customers.all(size: 20, page: 0)
     #
     def all(params = {})
-      response, status = BeyondApi::Request.get(@session, "/customers", params)
-
-      handle_response(response, status)
+      handle_all_request("/customers", :customers, params)
     end
 
     #
diff --git a/lib/beyond_api/resources/orders.rb b/lib/beyond_api/resources/orders.rb
@@ -57,6 +57,7 @@ def active_refund_process(order_id)
     #
     # @beyond_api.scopes +ordr:r+
     #
+    # @option params [Boolean] :paginated
     # @option params [Integer] :size the page size
     # @option params [Integer] :page the page number
     #
@@ -66,9 +67,7 @@ def active_refund_process(order_id)
     #   @orders = session.orders.all(size: 100, page: 0)
     #
     def all(params = {})
-      response, status = BeyondApi::Request.get(@session, "/orders", params)
-
-      handle_response(response, status)
+      handle_all_request("/orders", :orders, params)
     end
 
     #
diff --git a/lib/beyond_api/resources/payment_methods.rb b/lib/beyond_api/resources/payment_methods.rb
@@ -38,6 +38,7 @@ def activate(payment_method_id)
     #
     # @beyond_api.scopes +pymt:r+
     #
+    # @option params [Boolean] :paginated
     # @option params [Integer] :size the page size
     # @option params [Integer] :page the page number
     #
@@ -47,9 +48,7 @@ def activate(payment_method_id)
     #   @payment_methods = session.payment_methods.all(size: 100, page: 0)
     #
     def all(params = {})
-      response, status = BeyondApi::Request.get(@session, "/payment-methods", params)
-
-      handle_response(response, status)
+      handle_all_request("/payment-methods", :payment_methods, params)
     end
 
     #
diff --git a/lib/beyond_api/resources/product_attribute_definitions.rb b/lib/beyond_api/resources/product_attribute_definitions.rb
@@ -24,19 +24,7 @@ class ProductAttributeDefinitions < Base
     #   @product_attribute_definitions = session.product_attribute_definitions.all(size: 100, page: 0)
     #
     def all(params = {})
-      if params[:paginated] == false
-        result = all_paginated(page: 0, size: 1000)
-
-        (1..result[:page][:total_pages] - 1).each do |page|
-          result[:embedded][:product_attribute_definition].concat(all_paginated(page: page, size: 1000)[:embedded][:product_attribute_definitions])
-        end
-
-        result.is_a?(Hash) ? result.delete(:page) : result.delete_field(:page)
-
-        result
-      else
-        all_paginated(params)
-      end
+      handle_all_request("/product-attribute-definitions", :product_attribute_definitions, params)
     end
 
     #
@@ -114,12 +102,5 @@ def find(product_attribute_name)
 
       handle_response(response, status)
     end
-
-    private
-
-      def all_paginated(params = {})
-        response, status = BeyondApi::Request.get(@session, "/product-attribute-definitions", params)
-        handle_response(response, status)
-      end
   end
 end
diff --git a/lib/beyond_api/resources/products.rb b/lib/beyond_api/resources/products.rb
@@ -42,19 +42,7 @@ class Products < Base
     #   @products = session.products.all(size: 100, page: 0)
     #
     def all(params = {})
-      if params[:paginated] == false
-        result = all_paginated(page: 0, size: 1000)
-
-        (1..result[:page][:total_pages] - 1).each do |page|
-          result[:embedded][:products].concat(all_paginated(page: page, size: 1000)[:embedded][:products])
-        end
-
-        result.is_a?(Hash) ? result.delete(:page) : result.delete_field(:page)
-
-        result
-      else
-        all_paginated(params)
-      end
+      handle_all_request("/products", :products, params)
     end
 
     #
@@ -293,13 +281,5 @@ def assign_variation_images_differentiator(product_id, differentiator)
     alias_method :create_variation, :create
     alias_method :find_variation,   :find
     alias_method :update_variation, :update
-
-    private
-
-      def all_paginated(params = {})
-        response, status = BeyondApi::Request.get(@session, "/products", params)
-
-        handle_response(response, status)
-      end
   end
 end
diff --git a/lib/beyond_api/resources/products_view.rb b/lib/beyond_api/resources/products_view.rb
@@ -13,6 +13,7 @@ class ProductsView < Base
     #       -H 'Content-Type: application/json' \
     #       -H 'Accept: application/hal+json'
     #
+    # @option params [Boolean] :paginated
     # @option params [Integer] :size the page size
     # @option params [Integer] :page the page number
     #
@@ -22,9 +23,7 @@ class ProductsView < Base
     #   @products = session.products_view.all(page: 0, size: 100)
     #
     def all(params = {})
-      response, status = BeyondApi::Request.get(@session, "/product-view/products", params)
-
-      handle_response(response, status)
+      handle_all_request("/product-view/products", :products, params)
     end
 
     #
diff --git a/lib/beyond_api/resources/script_tags.rb b/lib/beyond_api/resources/script_tags.rb
@@ -12,6 +12,7 @@ class ScriptTags < Base
     #   $ curl 'https://api-shop.beyondshop.cloud/api/script-tags' -i -X GET \
     #       -H 'Authorization: Bearer <Access token>'
     #
+    # @option params [Boolean] :paginated
     # @option params [Integer] :size the page size
     # @option params [Integer] :page the page number
     #
@@ -21,9 +22,7 @@ class ScriptTags < Base
     #   @script_tags = session.script_tags.all(size: 20, page: 0)
     #
     def all(params = {})
-      response, status = BeyondApi::Request.get(@session, "/script-tags", params)
-
-      handle_response(response, status)
+      handle_all_request("/script-tags", :script_tags, params)
     end
 
     #
diff --git a/lib/beyond_api/resources/shipping_zones.rb b/lib/beyond_api/resources/shipping_zones.rb
@@ -14,6 +14,7 @@ class ShippingZones < Base
     #   $ curl 'https://api-shop.beyondshop.cloud/api/shipping-zones' -i -X GET \
     #       -H 'Authorization: Bearer <Access token>'
     #
+    # @option params [Boolean] :paginated
     # @option params [Integer] :size the page size
     # @option params [Integer] :page the page number
     #
@@ -23,9 +24,7 @@ class ShippingZones < Base
     #   @shipping_zones = session.shipping_zones.all(size: 20, page: 0)
     #
     def all(params = {})
-      response, status = BeyondApi::Request.get(@session, "/shipping-zones", params)
-
-      handle_response(response, status)
+      handle_all_request("/shipping-zones", :shipping_zones, params)
     end
 
     #
diff --git a/lib/beyond_api/resources/token.rb b/lib/beyond_api/resources/token.rb
@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
+require "beyond_api/utils"
+
 module BeyondApi
   class Token
     class InvalidSessionError < StandardError; end
 
+    include BeyondApi::Utils
+
     attr_reader :session
 
     def initialize(session)
@@ -44,7 +48,7 @@ def handle_response(response, status)
         @session.refresh_token = response["refresh_token"]
         @session
       else
-        BeyondApi::Error.new(response)
+        handle_error(response, status)
       end
     end
   end
diff --git a/lib/beyond_api/resources/users.rb b/lib/beyond_api/resources/users.rb
@@ -40,6 +40,7 @@ def add_roles(user_id, body)
     #
     # @beyond_api.scopes +user:r+
     #
+    # @option params [Boolean] :paginated
     # @option params [Integer] :size the page size
     # @option params [Integer] :page the page number
     #
@@ -49,9 +50,7 @@ def add_roles(user_id, body)
     #   @users = session.users.all(size: 100, page: 0)
     #
     def all(params = {})
-      response, status = BeyondApi::Request.get(@session, "/users")
-
-      handle_response(response, status)
+      handle_all_request("/users", :users, params)
     end
 
     #
diff --git a/lib/beyond_api/resources/webhook_subscriptions.rb b/lib/beyond_api/resources/webhook_subscriptions.rb
@@ -34,6 +34,7 @@ def activate(webhook_subscription_id)
     #       -H 'Accept: application/hal+json' \
     #       -H 'Authorization: Bearer <Access token>'
     #
+    # @option params [Boolean] :paginated
     # @option params [Integer] :size the page size
     # @option params [Integer] :page the page number
     #
@@ -43,9 +44,7 @@ def activate(webhook_subscription_id)
     #   @webhook_subscriptions = session.webhook_subscriptions.all(size: 100, page: 0)
     #
     def all(params = {})
-      response, status = BeyondApi::Request.get(@session, "/webhook-subscriptions", params)
-
-      handle_response(response, status)
+      handle_all_request("/webhook-subscriptions", :webhook_subscriptions, params)
     end
 
     #
diff --git a/lib/beyond_api/utils.rb b/lib/beyond_api/utils.rb
@@ -10,11 +10,16 @@ def handle_response(response, status, respond_with_true: false)
         response = sanitize_response(response)
         BeyondApi.configuration.object_struct_responses ? to_object_struct(response) : response
       else
-        BeyondApi.logger.error "[Beyond API] #{response}"
-        BeyondApi.configuration.raise_error_requests ? raise(response.to_s) : BeyondApi::Error.new(response)
+        handle_error(response, status)
       end
     end
 
+    def handle_error(response, status)
+      BeyondApi.logger.error "[Beyond API] #{status}: #{response}"
+      error = BeyondApi::Error.new(response, status)
+      BeyondApi.configuration.raise_error_requests ? raise(error) : error
+    end
+
     def to_object_struct(data)
       if data.is_a? Hash
         return OpenStruct.new(data.map { |key, val| [key, to_object_struct(val)] }.to_h)
@@ -39,6 +44,22 @@ def sanitize_key(key)
       key.chars.first == "_" ? key[1..-1] : key
     end
 
+    def handle_all_request(url, resource, params = {})
+      if params[:paginated] == false
+        result = all_paginated(url, { page: 0, size: 1000 })
+
+        (1..result[:page][:total_pages] - 1).each do |page|
+          result[:embedded][resource].concat(all_paginated(url, { page: page, size: 1000 })[:embedded][resource])
+        end
+
+        result.is_a?(Hash) ? result.delete(:page) : result.delete_field(:page)
+
+        result
+      else
+        all_paginated(url, params)
+      end
+    end
+
     private
 
       def transform(thing)
@@ -48,5 +69,11 @@ def transform(thing)
         else; thing
         end
       end
+
+      def all_paginated(url, params = {})
+        response, status = BeyondApi::Request.get(@session, url, params)
+
+        handle_response(response, status)
+      end
   end
 end
diff --git a/lib/beyond_api/version.rb b/lib/beyond_api/version.rb
@@ -1,3 +1,3 @@
 module BeyondApi
-  VERSION = "0.9.0.pre".freeze
+  VERSION = "0.11.0.pre".freeze
 end

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@ class Categories < Base`
`16`	`16`	`#`
`17`	`17`	`# @beyond_api.scopes +catg:r+`
`18`	`18`	`#`
	`19`	`+ # @option params [Boolean] :paginated`
`19`	`20`	`# @option params [Integer] :size the page size`
`20`	`21`	`# @option params [Integer] :page the page number`
`21`	`22`	`#`
`@@ -25,9 +26,7 @@ class Categories < Base`
`25`	`26`	`# @categories = session.categories.all(size: 100, page: 0)`
`26`	`27`	`#`
`27`	`28`	`def all(params = {})`
`28`		`- response, status = BeyondApi::Request.get(@session, "/categories", params)`
`29`		`-`
`30`		`- handle_response(response, status)`
	`29`	`+ handle_all_request("/categories", :categories, params)`
`31`	`30`	`end`
`32`	`31`
`33`	`32`	`#`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@ class CategoriesView < Base`
`14`	`14`	`# -H 'Accept: application/hal+json'`
`15`	`15`	`#`
`16`	`16`	`#`
	`17`	`+ # @option params [Boolean] :paginated`
`17`	`18`	`# @option params [Integer] :size the page size`
`18`	`19`	`# @option params [Integer] :page the page number`
`19`	`20`	`#`
`@@ -23,9 +24,7 @@ class CategoriesView < Base`
`23`	`24`	`# @categories = session.categories_view.all(size: 100, page: 0)`
`24`	`25`	`#`
`25`	`26`	`def all(params = {})`
`26`		`- response, status = BeyondApi::Request.get(@session, "/product-view/categories", params)`
`27`		`-`
`28`		`- handle_response(response, status)`
	`27`	`+ handle_all_request("/product-view/categories", :categories, params)`
`29`	`28`	`end`
`30`	`29`
`31`	`30`	`#`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@ class Customers < Base`
`14`	`14`	`#`
`15`	`15`	`# @beyond_api.scopes +cust:r+`
`16`	`16`	`#`
	`17`	`+ # @option params [Boolean] :paginated`
`17`	`18`	`# @option params [Integer] :size the page size`
`18`	`19`	`# @option params [Integer] :page the page number`
`19`	`20`	`#`
`@@ -23,9 +24,7 @@ class Customers < Base`
`23`	`24`	`# @customers = session.customers.all(size: 20, page: 0)`
`24`	`25`	`#`
`25`	`26`	`def all(params = {})`
`26`		`- response, status = BeyondApi::Request.get(@session, "/customers", params)`
`27`		`-`
`28`		`- handle_response(response, status)`
	`27`	`+ handle_all_request("/customers", :customers, params)`
`29`	`28`	`end`
`30`	`29`
`31`	`30`	`#`
Original file line number	Diff line number	Diff line change
`@@ -57,6 +57,7 @@ def active_refund_process(order_id)`
`57`	`57`	`#`
`58`	`58`	`# @beyond_api.scopes +ordr:r+`
`59`	`59`	`#`
	`60`	`+ # @option params [Boolean] :paginated`
`60`	`61`	`# @option params [Integer] :size the page size`
`61`	`62`	`# @option params [Integer] :page the page number`
`62`	`63`	`#`
`@@ -66,9 +67,7 @@ def active_refund_process(order_id)`
`66`	`67`	`# @orders = session.orders.all(size: 100, page: 0)`
`67`	`68`	`#`
`68`	`69`	`def all(params = {})`
`69`		`- response, status = BeyondApi::Request.get(@session, "/orders", params)`
`70`		`-`
`71`		`- handle_response(response, status)`
	`70`	`+ handle_all_request("/orders", :orders, params)`
`72`	`71`	`end`
`73`	`72`
`74`	`73`	`#`
Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,7 @@ def activate(payment_method_id)`
`38`	`38`	`#`
`39`	`39`	`# @beyond_api.scopes +pymt:r+`
`40`	`40`	`#`
	`41`	`+ # @option params [Boolean] :paginated`
`41`	`42`	`# @option params [Integer] :size the page size`
`42`	`43`	`# @option params [Integer] :page the page number`
`43`	`44`	`#`
`@@ -47,9 +48,7 @@ def activate(payment_method_id)`
`47`	`48`	`# @payment_methods = session.payment_methods.all(size: 100, page: 0)`
`48`	`49`	`#`
`49`	`50`	`def all(params = {})`
`50`		`- response, status = BeyondApi::Request.get(@session, "/payment-methods", params)`
`51`		`-`
`52`		`- handle_response(response, status)`
	`51`	`+ handle_all_request("/payment-methods", :payment_methods, params)`
`53`	`52`	`end`
`54`	`53`
`55`	`54`	`#`