beyond_api 0.9.0.pre → 0.10.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8eb69d55a6ff81113a94022f031b7c09c6dd0e51a4337d48dc698d5aa6a79153
-  data.tar.gz: 3b782cea11e4d0533827192fc8141519b487d034bf194657f05e01c04895458c
+  metadata.gz: 70c9bf9ccb3e7a42a71c8d5a092e0af6969842daf91a7219398b9f5516836cfe
+  data.tar.gz: d976cda9fdcc8df93394b3b9ad678453db3634a096c6832208e8fe49c917198b
 SHA512:
-  metadata.gz: 705ebbe6fb68e9a8e4b456978d9d05af02ed03cf96c5002ad384037cda169a9074a99aa71e57e3e83a9e9651aa2662d21eeb7b2a11ac4c60e53a97fe7d35b59e
-  data.tar.gz: fbba10e64cdb172ee326d1092841c2212683377a3f8325b3bcce1340cf76e149edb8ab2dfe0f9a3e5ea158b3dedc64915c19cf6ff8fe71293bdc3e89321fc19c
+  metadata.gz: 94e86e146eb7ed0696efbb7bf7a61e1ade093ba00571ef140e0fb019c6708680d8a26b3b0bc8295e3f30a1327b362b44b0b56b7b474973a975fd212e61317c90
+  data.tar.gz: 68cc2ad0ec1a9d855dc22c52ca4b5f9a1a76af244eeccc406bb7e384b72267c476f99db47652b34653a9d297836e7637ac9856e60eab09961eec7ea6e8733688

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+### 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    beyond_api (0.9.0.pre)
+    beyond_api (0.10.0.pre)
       faraday (~> 0.15)
 
 GEM

data/lib/beyond_api/resources/categories.rb

@@ -16,6 +16,7 @@ module BeyondApi
     #
     # @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 @@ module BeyondApi
     #   @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
 
     #

data/lib/beyond_api/resources/categories_view.rb

@@ -14,6 +14,7 @@ module BeyondApi
     #       -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 @@ module BeyondApi
     #   @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
 
     #

data/lib/beyond_api/resources/customers.rb

@@ -14,6 +14,7 @@ module BeyondApi
     #
     # @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 @@ module BeyondApi
     #   @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
 
     #

data/lib/beyond_api/resources/orders.rb

@@ -57,6 +57,7 @@ module BeyondApi
     #
     # @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 @@ module BeyondApi
     #   @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
 
     #

data/lib/beyond_api/resources/payment_methods.rb

@@ -38,6 +38,7 @@ module BeyondApi
     #
     # @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 @@ module BeyondApi
     #   @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
 
     #

data/lib/beyond_api/resources/product_attribute_definitions.rb

@@ -24,19 +24,7 @@ module BeyondApi
     #   @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 @@ module BeyondApi
 
       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

data/lib/beyond_api/resources/products.rb

@@ -42,19 +42,7 @@ module BeyondApi
     #   @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 @@ module BeyondApi
     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

data/lib/beyond_api/resources/products_view.rb

@@ -13,6 +13,7 @@ module BeyondApi
     #       -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 @@ module BeyondApi
     #   @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
 
     #

data/lib/beyond_api/resources/script_tags.rb

@@ -12,6 +12,7 @@ module BeyondApi
     #   $ 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 @@ module BeyondApi
     #   @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
 
     #

data/lib/beyond_api/resources/shipping_zones.rb

@@ -14,6 +14,7 @@ module BeyondApi
     #   $ 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 @@ module BeyondApi
     #   @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
 
     #

data/lib/beyond_api/resources/users.rb

@@ -40,6 +40,7 @@ module BeyondApi
     #
     # @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 @@ module BeyondApi
     #   @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
 
     #

data/lib/beyond_api/resources/webhook_subscriptions.rb

@@ -34,6 +34,7 @@ module BeyondApi
     #       -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 @@ module BeyondApi
     #   @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
 
     #

data/lib/beyond_api/utils.rb

@@ -39,6 +39,22 @@ module BeyondApi
       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 +64,11 @@ module BeyondApi
         else; thing
         end
       end
+
+      def all_paginated(url, params = {})
+        response, status = BeyondApi::Request.get(@session, url, params)
+
+        handle_response(response, status)
+      end
   end
 end

data/lib/beyond_api/version.rb

@@ -1,3 +1,3 @@
 module BeyondApi
-  VERSION = "0.9.0.pre".freeze
+  VERSION = "0.10.0.pre".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beyond_api
 version: !ruby/object:Gem::Version
-  version: 0.9.0.pre
+  version: 0.10.0.pre
 platform: ruby
 authors:
 - Unai Abrisketa
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-11 00:00:00.000000000 Z
+date: 2020-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler