Merge remote-tracking branch 'upstream/master'

Author: gersanco

CHANGELOG.md

@@ -1,3 +1,29 @@
+### v0.18.1.pre
+
+* bug-fixes
+  * Prevent logging `code` and `refresh_token` on `/api/token` calls
+
+### v0.18.0.pre
+
+* features
+  * Add new token retrieval/refresh methods
+    * `Token#authorization_code`
+    * `Token#refresh_token`
+    * `Token#client_credentials`
+  * Add alias methods for avoiding deprecation
+    * `refresh` -> `refresh_token`
+    * `create`  -> `authorization_code`
+
+### v0.17.0.pre
+
+* enhancements
+  * Add customizable pagination size when sending `paginated: false` parameter to `#all` requests.
+
+### v0.16.1.pre
+
+* bug-fixes
+  * Fix method to retrieve resources without pagination
+
 ### v0.16.0.pre
 
 * features
@@ -21,7 +47,7 @@
 
 * features
   * Add `Products#assign_variation_attribute_as_differentiator`
-  
+
 ### v0.13.0.pre
 
 * features

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    beyond_api (0.16.0.pre)
+    beyond_api (0.18.1.pre)
       faraday (~> 0.15)
 
 GEM
@@ -52,4 +52,4 @@ DEPENDENCIES
   yard (~> 0.9)
 
 BUNDLED WITH
-   2.1.4
+   2.2.26

beyond_api.gemspec

@@ -6,7 +6,7 @@ require "beyond_api/version"
 Gem::Specification.new do |spec|
   spec.name          = "beyond_api"
   spec.version       = BeyondApi::VERSION
-  spec.authors       = ["Unai Abrisketa", "Kathia Salazar", "German San Emeterio"]
+  spec.authors       = ["Unai Abrisketa", "Kathia Salazar", "German San Emeterio", "Kenneth Gallego"]
 
   spec.summary       = "Ruby client to access the Beyond API"
   spec.homepage      = "https://github.com/ePages-de/beyond_api-ruby_client"

lib/beyond_api.rb

@@ -27,7 +27,7 @@ def self.setup
   class Configuration
     attr_accessor :client_id, :client_secret, :open_timeout, :timeout,  :remove_response_links,
                   :remove_response_key_underscores, :object_struct_responses, :raise_error_requests,
-                  :log_headers, :log_bodies, :log_level
+                  :log_headers, :log_bodies, :log_level, :all_pagination_size
 
     def initialize
       @client_id = nil
@@ -42,6 +42,8 @@ def initialize
       @log_level = :info
       @log_headers = false
       @log_bodies = false
+
+      @all_pagination_size = 200
     end
   end
 end

lib/beyond_api/connection.rb

@@ -26,7 +26,10 @@ def self.token
         faraday.options[:open_timeout] = BeyondApi.configuration.open_timeout.to_i
         faraday.options[:timeout] = BeyondApi.configuration.timeout.to_i
         faraday.response :logger, LOGGER, { headers: BeyondApi.configuration.log_headers,
-                                            bodies: BeyondApi.configuration.log_bodies }
+                                            bodies: BeyondApi.configuration.log_bodies } do |logger|
+          logger.filter(/(code=)([a-zA-Z0-9]+)/, '\1[FILTERED]')
+          logger.filter(/(refresh_token=)([a-zA-Z0-9.\-\_]+)/, '\1[FILTERED]')
+        end
         faraday.headers['Accept'] = 'application/json'
         faraday.adapter(:net_http)
         faraday.basic_auth(BeyondApi.configuration.client_id,

lib/beyond_api/resources/products.rb

@@ -98,8 +98,8 @@ def all(params = {})
     #       }
     #     },
     #     "shippingPeriod" : {
-    #       "minDays" : 2,
-    #       "maxDays" : 4,
+    #       "min" : 2,
+    #       "max" : 4,
     #       "displayUnit" : "WEEKS"
     #     }
     #   }'
@@ -157,8 +157,8 @@ def all(params = {})
     #      }
     #    },
     #    "shippingPeriod": {
-    #      "minDays": 2,
-    #      "maxDays": 4,
+    #      "min": 2,
+    #      "max": 4,
     #      "displayUnit": "WEEKS"
     #    }
     #   }

lib/beyond_api/resources/token.rb

@@ -17,31 +17,32 @@ def initialize(session)
       raise InvalidSessionError.new("Session api_url cannot be nil") if session.api_url.nil?
     end
 
-    def create(code)
-      response, status = BeyondApi::Request.token(@session.api_url + "/oauth/token",
-                                                  grant_type: "authorization_code",
-                                                  code: code)
-
-      handle_response(response, status)
+    def authorization_code(code)
+      handle_token_call("authorization_code", code: code)
     end
 
-    def refresh
-      response, status = BeyondApi::Request.token(@session.api_url + "/oauth/token",
-                                                  grant_type: "refresh_token",
-                                                  refresh_token: @session.refresh_token)
-
-      handle_response(response, status)
+    def refresh_token
+      handle_token_call("refresh_token", refresh_token: @session.refresh_token)
     end
 
     def client_credentials
+      handle_token_call("client_credentials")
+    end
+
+    alias_method :refresh, :refresh_token
+    alias_method :create, :authorization_code
+
+    private
+
+    def handle_token_call(grant_type, params = {})
+      params.merge!(grant_type: grant_type)
+
       response, status = BeyondApi::Request.token(@session.api_url + "/oauth/token",
-                                                  grant_type: "client_credentials")
+                                                  params)
 
       handle_response(response, status)
     end
 
-    private
-
     def handle_response(response, status)
       if status.between?(200, 299)
         @session.access_token = response["access_token"]

lib/beyond_api/utils.rb

@@ -45,14 +45,18 @@ def sanitize_key(key)
     end
 
     def handle_all_request(url, resource, params = {})
+      paginated_size = BeyondApi.configuration.all_pagination_size
+
       if params[:paginated] == false
-        result = all_paginated(url, { page: 0, size: 1000 })
+        result = all_paginated(url, params.merge(page: 0, size: paginated_size))
 
         (1..result[:page][:total_pages] - 1).each do |page|
-          result[:embedded][resource].concat(all_paginated(url, { page: page, size: 1000 })[:embedded][resource])
+          result[:embedded][resource].concat(all_paginated(url, params.merge(page: page, size: paginated_size))[:embedded][resource])
         end
 
-        result.is_a?(Hash) ? result.delete(:page) : result.delete_field(:page)
+        result[:page][:size] = result[:page][:total_elements]
+        result[:page][:total_pages] = 1
+        result[:page][:number] = 0
 
         result
       else

lib/beyond_api/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BeyondApi
-  VERSION = "0.16.0.pre".freeze
+  VERSION = "0.18.1.pre"
 end

lib/generators/templates/beyond_api_initializer.rb

@@ -12,6 +12,9 @@
   # Configure the request timeout in seconds. Default is 5 seconds.
   # config.timeout = 5.seconds
 
+  # Configure the pagination size when `paginated: false` is sent on `.all()` requests. Value must be between 1 and 1000.
+  # config.all_pagination_size = 200
+
   # ==> Log configuration
 
   # Configure the log level. Must be one of :debug, :info, :warn, :error,