hubrise_client 2.0.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f10358d2bbba5919834bc9209feafaa301aee68fa07153aad77a5e31c3844a28
-  data.tar.gz: 4d881d4e77a8df23a4dfc784e3b8505db21859dee1f69bfcd18e2c683b5e1044
+  metadata.gz: 58aebdf2e9ba790c1303eacf547aaaf5ccdf92f360a63195e6a6e9db1e200b42
+  data.tar.gz: 3776550d4ef358b832c1e4f02094da4ef352b8fddb5ce2d174ae092c6f6ce504
 SHA512:
-  metadata.gz: 865672a43693575a2493bd2b2edf3e2e1ef95268065bf6bfa9c5398045fda40537c501f0f74741f36443541491c84a4b10ccaabb9c3dafcb7e22c80e2bfb31fd
-  data.tar.gz: eeb709dfdb5216f72d15afe73f53913847744e54c70f6119bf24d2e5377d79bbc118536544b5b6a8a70b82b3ca115dbc1503b53b56bb16527bd5f7aa06e72439
+  metadata.gz: 38787fe30bacac00daae63823a52d69f10347380276afb7b8e9c87386560aed7d97300c66a9abe29dcc03c3ccb3de43f11b9cfca14b3c2d432fd8426ab8ffe4c
+  data.tar.gz: c8304210fb9fcb47b574d131b690f3e3ac11e7be4ce3633e37ef64aa320a3fcf3a1615066789558aa331bd18b5e61c54651d2e2ecbb6fd0fc681e9e6fa777934

data/README.md

@@ -78,3 +78,21 @@ Now you can call the [helper methods](https://github.com/HubRise/ruby-client/blo
 ```ruby
 client.get_account
 ```
+
+## Pagination
+
+`#next_page?`, `#next_page` and `#each_page` might be helpful when working with paginated [endpoints](https://www.hubrise.com/developers/api/general-concepts/#pagination)
+
+```ruby
+response = client.get_all_customers
+
+response.next_page?
+# => true
+
+response.next_page.data
+# => [{ first_name:... }]
+
+response.each_page do |page_response|
+    page_response.data
+    # => [{ first_name:... }]
+end

data/lib/hubrise_client/base.rb

@@ -18,13 +18,13 @@ module HubriseClient
                   :request_callback
 
     def initialize(app_id, app_secret, params = {})
-      @app_id     = app_id
+      @app_id = app_id
       @app_secret = app_secret
-      @api_host   = params[:api_host] || DEFAULT_API_HOST
-      @api_port   = params[:api_port] || DEFAULT_API_PORT
+      @api_host = params[:api_host] || DEFAULT_API_HOST
+      @api_port = params[:api_port] || DEFAULT_API_PORT
       @oauth_host = params[:oauth_host] || DEFAULT_OAUTH_HOST
       @oauth_port = params[:oauth_port] || DEFAULT_OAUTH_PORT
-      @use_https  = !!params.fetch(:use_https, USE_HTTPS)
+      @use_https = !!params.fetch(:use_https, USE_HTTPS)
       @request_callback = params[:request_callback]
 
       initialize_scope_params(params)
@@ -47,10 +47,13 @@ module HubriseClient
     end
 
     def authorize!(authorization_code)
-      api_response = api_request(oauth2_hubrise_hostname_with_version).perform(:post, "/token",
-                                                                               client_id: @app_id,
-                                                                               client_secret: @app_secret,
-                                                                               code: authorization_code)
+      api_response = api_request(
+        oauth2_hubrise_hostname_with_version, "/token", :post, data: {
+          client_id: @app_id,
+          client_secret: @app_secret,
+          code: authorization_code,
+        }
+      ).perform
 
       case api_response.code
       when "200"
@@ -67,33 +70,37 @@ module HubriseClient
     protected
 
     def initialize_scope_params(params)
-      @access_token     = params[:access_token] || params["access_token"]
-      @app_instance_id  = params[:app_instance_id] || params["app_instance_id"]
-      @user_id          = params[:user_id] || params["user_id"]
-      @account_id       = params[:account_id] || params["account_id"]
-      @location_id      = params[:location_id] || params["location_id"]
-      @catalog_id       = params[:catalog_id] || params["catalog_id"]
+      @access_token = params[:access_token] || params["access_token"]
+      @app_instance_id = params[:app_instance_id] || params["app_instance_id"]
+      @user_id = params[:user_id] || params["user_id"]
+      @account_id = params[:account_id] || params["account_id"]
+      @location_id = params[:location_id] || params["location_id"]
+      @catalog_id = params[:catalog_id] || params["catalog_id"]
       @customer_list_id = params[:customer_list_id] || params["customer_list_id"]
     end
 
     def call_api(path, method = :get, data: {}, headers: {}, json: true)
       raise(HubriseAccessTokenMissing) if @access_token.nil?
 
-      api_request("#{@api_host}:#{@api_port}/#{version}", @access_token)
-        .perform(method,
-                 path,
-                 data,
-                 json: json,
-                 headers: headers,
-                 &@request_callback)
+      api_request(
+        "#{@api_host}:#{@api_port}/#{version}", path, method, data: data,
+                                                              json: json,
+                                                              headers: headers,
+                                                              access_token: @access_token,
+                                                              callback: @request_callback
+      ).perform
     end
 
-    def api_request(hostname, access_token = nil)
-      Request.new(
-        hostname: hostname,
-        access_token: access_token,
-        use_https: @use_https,
-        logger: @verbous && @logger
+    def api_request(hostname, path, method, attrs = {})
+      Request.from_h(
+        {
+          hostname: hostname,
+          path: path,
+          method: method,
+          use_https: @use_https,
+          logger: @verbous && @logger,
+          json: true,
+        }.merge(attrs)
       )
     end
 

data/lib/hubrise_client/request.rb

@@ -1,6 +1,16 @@
 # frozen_string_literal: true
 module HubriseClient
-  class Request
+  class Request < Struct.new(:hostname,
+                             :path,
+                             :method,
+                             :data,
+                             :access_token,
+                             :use_https,
+                             :logger,
+                             :json,
+                             :headers,
+                             :callback)
+
     REQUESTS_HASH = {
       get: Net::HTTP::Get,
       post: Net::HTTP::Post,
@@ -9,20 +19,17 @@ module HubriseClient
       delete: Net::HTTP::Delete,
     }.freeze
 
-    attr_reader :http_request
-    def initialize(hostname:, access_token: nil, use_https: false, logger: nil)
-      @hostname     = hostname
-      @access_token = access_token
-      @use_https    = use_https
-      @protocol     = use_https ? "https" : "http"
-      @logger       = logger
+    def self.from_h(hash)
+      new(*hash.values_at(*members))
     end
 
-    def perform(method, path, data, json: true, headers: {})
-      uri = URI.parse(@protocol + "://" + @hostname + path)
-      @http_request = build_request(uri, method, data, json: json, headers: headers)
-      @http_response = perform_request(uri, @http_request)
-      @response = Response.new(@http_response)
+    attr_reader :http_request
+
+    def perform
+      @http_request = build_request
+
+      @http_response = perform_request(@http_request)
+      @response = Response.new(@http_response, self)
 
       case @http_response
       when Net::HTTPUnauthorized
@@ -35,25 +42,41 @@ module HubriseClient
     rescue Errno::ECONNREFUSED
       raise HubriseError, "API is not reachable"
     ensure
-      yield(self, @response) if @http_request && block_given?
+      callback.call(self, @response) if @http_request && callback
+    end
+
+    def next_page_request(new_cursor)
+      new_data = data || {}
+      new_data[:cursor] = new_cursor
+
+      Request.from_h(to_h.merge(data: new_data))
     end
 
     protected
 
-    def build_request(uri, method, data, json:, headers:)
-      headers["X-Access-Token"] = @access_token if @access_token
+    def protocol
+      use_https ? "https" : "http"
+    end
 
-      if method == :get
-        uri = add_params_to_uri(uri, data) if data&.count&.positive?
+    def build_request
+      request_uri = URI.parse(protocol + "://" + hostname + path)
+
+      request_headers = headers || {}
+      request_headers["X-Access-Token"] = access_token if access_token
+
+      request_body_data = nil
 
-        data = nil
+      if method == :get
+        request_uri = add_params_to_uri(request_uri, data) if data && !data.empty?
       elsif json
-        headers["Content-Type"] ||= "application/json"
-        data = data.to_json
+        request_headers["Content-Type"] ||= "application/json"
+        request_body_data = data.to_json
+      else
+        request_body_data = data
       end
 
-      REQUESTS_HASH[method].new(uri, headers).tap do |request|
-        request.body = data
+      REQUESTS_HASH[method].new(request_uri, request_headers).tap do |request|
+        request.body = request_body_data
       end
     end
 
@@ -62,10 +85,12 @@ module HubriseClient
       uri
     end
 
-    def perform_request(uri, request)
-      http          = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl  = @use_https
-      http.set_debug_output(@logger) if @logger
+    def perform_request(request)
+      uri = request.uri
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = use_https
+      http.set_debug_output(logger) if logger
       http.request(request)
     end
   end

data/lib/hubrise_client/response.rb

@@ -4,9 +4,10 @@ module HubriseClient
     attr_reader :code, :failed, :data, :error_type, :error_message, :errors, :http_response
     alias_method :failed?, :failed
 
-    def initialize(http_response)
-      @http_response  = http_response
-      @code           = http_response.code
+    def initialize(http_response, request)
+      @http_response = http_response
+      @request = request
+      @code = http_response.code
 
       json_body = begin
                     JSON.parse(http_response.body)
@@ -32,5 +33,29 @@ module HubriseClient
     def retry_after
       http_response.is_a?(Net::HTTPTooManyRequests) && http_response["retry-after"].to_i
     end
+
+    def each_page
+      return enum_for(:each_page) unless block_given?
+
+      yield(self)
+
+      response = self
+      while response.next_page?
+        response = response.next_page
+        yield(response)
+      end
+    end
+
+    def next_page?
+      !!cursor_next
+    end
+
+    def next_page
+      @request.next_page_request(cursor_next).perform
+    end
+
+    def cursor_next
+      http_response["X-Cursor-Next"]
+    end
   end
 end

data/lib/hubrise_client/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module HubriseClient
-  VERSION = "2.0.3"
+  VERSION = "2.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hubrise_client
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.4
 platform: ruby
 authors:
 - Antoine Monnier
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-08 00:00:00.000000000 Z
+date: 2022-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec