Added Retry Function

Author: sunil-lakshman

lib/contentstack/api.rb

@@ -7,7 +7,7 @@
 module Contentstack
   class API
     using Utility
-    def self.init_api(api_key, delivery_token, environment, host, branch, live_preview, proxy)
+    def self.init_api(api_key, delivery_token, environment, host, branch, live_preview, proxy, retry_options)
       @host = host
       @api_version = '/v3'
       @environment = environment
@@ -17,6 +17,10 @@ def self.init_api(api_key, delivery_token, environment, host, branch, live_previ
       @headers = {environment: @environment}
       @live_preview = live_preview
       @proxy_details = proxy
+      @timeout = retry_options["timeout"]
+      @retryDelay = retry_options["retryDelay"]
+      @retryLimit = retry_options["retryLimit"]
+      @errorRetry = retry_options["errorRetry"]
     end
 
     def self.live_preview_query(query= {})
@@ -30,7 +34,7 @@ def self.fetch_content_types(uid="")
       else
         path = "/content_types"
       end
-      send_request(path, {})
+      fetch_retry(path, {})
     end
 
     def self.fetch_entries(content_type, query)
@@ -39,7 +43,7 @@ def self.fetch_entries(content_type, query)
         send_preview_request(path, query)  
       else
         path = "/content_types/#{content_type}/entries"
-        send_request(path, query)
+        fetch_retry(path, query)
       end
     end
 
@@ -49,22 +53,37 @@ def self.fetch_entry(content_type, entry_uid, query)
         send_preview_request(path, query)  
       else
         path = "/content_types/#{content_type}/entries/#{entry_uid}"
-        send_request(path, query)
+        fetch_retry(path, query)
       end
     end
 
     def self.get_assets(asset_uid=nil)
       path = "/assets"
       path += "/#{asset_uid}" if !asset_uid.nil?
-      send_request(path)
+      fetch_retry(path)
     end
 
     def self.get_sync_items(query)
       path = "/stacks/sync"
-      send_request(path, query)
+      fetch_retry(path, query)
     end
 
     private
+    def self.fetch_retry(path, query=nil, count=0)
+      response = send_request(path, query)
+      if @errorRetry.include?(response["status_code"].to_i)
+        if count < @retryLimit
+          retryDelay_in_seconds = @retryDelay / 1000 #converting retry_delay from milliseconds into seconds
+          sleep(retryDelay_in_seconds.to_i) #sleep method requires time in seconds as parameter
+          response = fetch_retry(path, query, (count + 1))
+        else
+         raise Contentstack::Error.new(response) #Retry Limit exceeded
+        end  
+      else
+        response
+      end
+    end
+
     def self.send_request(path, q=nil)
       q ||= {}
 
@@ -76,7 +95,8 @@ def self.send_request(path, q=nil)
         "api_key" =>  @api_key,
         "access_token"=>  @access_token,
         "user_agent"=> "ruby-sdk/#{Contentstack::VERSION}",
-        "x-user-agent" => "ruby-sdk/#{Contentstack::VERSION}"
+        "x-user-agent" => "ruby-sdk/#{Contentstack::VERSION}",
+        "read_timeout" => @timeout
       }
       if !@branch.nil? && !@branch.empty?
         params["branch"] = @branch
@@ -91,12 +111,12 @@ def self.send_request(path, q=nil)
         proxy_username = @proxy_details[:username]
         proxy_password = @proxy_details[:password]
 
-        ActiveSupport::JSON.decode(URI.open("#{@host}#{@api_version}#{path}#{query}", :proxy_http_basic_authentication => [proxy_uri, proxy_username, proxy_password], "api_key" =>  @api_key, "access_token"=>  @access_token, "user_agent"=> "ruby-sdk/#{Contentstack::VERSION}", "x-user-agent" => "ruby-sdk/#{Contentstack::VERSION}").read)
+        ActiveSupport::JSON.decode(URI.open("#{@host}#{@api_version}#{path}#{query}", :proxy_http_basic_authentication => [proxy_uri, proxy_username, proxy_password], "api_key" =>  @api_key, "access_token"=>  @access_token, "user_agent"=> "ruby-sdk/#{Contentstack::VERSION}", "x-user-agent" => "ruby-sdk/#{Contentstack::VERSION}", "read_timeout" => @timeout).read)
 
       elsif @proxy_details.present? && @proxy_details[:url].present? && @proxy_details[:port].present? && @proxy_details[:username].empty? && @proxy_details[:password].empty?
         proxy_uri = URI.parse("http://#{@proxy_details[:url]}:#{@proxy_details[:port]}/")
 
-        ActiveSupport::JSON.decode(URI.open("#{@host}#{@api_version}#{path}#{query}", "proxy" => proxy_uri, "api_key" =>  @api_key, "access_token"=>  @access_token, "user_agent"=> "ruby-sdk/#{Contentstack::VERSION}", "x-user-agent" => "ruby-sdk/#{Contentstack::VERSION}").read)
+        ActiveSupport::JSON.decode(URI.open("#{@host}#{@api_version}#{path}#{query}", "proxy" => proxy_uri, "api_key" =>  @api_key, "access_token"=>  @access_token, "user_agent"=> "ruby-sdk/#{Contentstack::VERSION}", "x-user-agent" => "ruby-sdk/#{Contentstack::VERSION}", "read_timeout" => @timeout).read)
 
         end
     end
@@ -110,9 +130,10 @@ def self.send_preview_request(path, q=nil)
       preview_host = @live_preview[:host]
       params = {
         "api_key" =>  @api_key,
-        "authorization" => @live_preview[:management_token],
+        "access_token"=>  @access_token,
         "user_agent"=> "ruby-sdk/#{Contentstack::VERSION}",
-        "x-user-agent" => "ruby-sdk/#{Contentstack::VERSION}"
+        "x-user-agent" => "ruby-sdk/#{Contentstack::VERSION}",
+        "read_timeout" => @timeout
       }
       if !@branch.nil? && !@branch.empty?
         params["branch"] = @branch
@@ -128,12 +149,12 @@ def self.send_preview_request(path, q=nil)
         proxy_username = @proxy_details[:username]
         proxy_password = @proxy_details[:password]
 
-        ActiveSupport::JSON.decode(URI.open("#{preview_host}#{@api_version}#{path}#{query}", :proxy_http_basic_authentication => [proxy_uri, proxy_username, proxy_password], "api_key" =>  @api_key, "authorization" => @live_preview[:management_token], "user_agent"=> "ruby-sdk/#{Contentstack::VERSION}", "x-user-agent" => "ruby-sdk/#{Contentstack::VERSION}").read)
+        ActiveSupport::JSON.decode(URI.open("#{preview_host}#{@api_version}#{path}#{query}", :proxy_http_basic_authentication => [proxy_uri, proxy_username, proxy_password], "api_key" =>  @api_key, "authorization" => @live_preview[:management_token], "user_agent"=> "ruby-sdk/#{Contentstack::VERSION}", "x-user-agent" => "ruby-sdk/#{Contentstack::VERSION}", "read_timeout" => @timeout).read)
 
       elsif @proxy_details.present? && @proxy_details[:url].present? && @proxy_details[:port].present? && @proxy_details[:username].empty? && @proxy_details[:password].empty?
         proxy_uri = URI.parse("http://#{@proxy_details[:url]}:#{@proxy_details[:port]}/")
 
-        ActiveSupport::JSON.decode(URI.open("#{preview_host}#{@api_version}#{path}#{query}", "proxy" => proxy_uri, "api_key" =>  @api_key, "authorization" => @live_preview[:management_token], "user_agent"=> "ruby-sdk/#{Contentstack::VERSION}", "x-user-agent" => "ruby-sdk/#{Contentstack::VERSION}").read)
+        ActiveSupport::JSON.decode(URI.open("#{preview_host}#{@api_version}#{path}#{query}", "proxy" => proxy_uri, "api_key" =>  @api_key, "authorization" => @live_preview[:management_token], "user_agent"=> "ruby-sdk/#{Contentstack::VERSION}", "x-user-agent" => "ruby-sdk/#{Contentstack::VERSION}", "read_timeout" => @timeout).read)
 
         end
     end

lib/contentstack/client.rb

@@ -14,9 +14,19 @@ def initialize(api_key, delivery_token, environment, options={})
       @live_preview = !options.key?(:live_preview) ? {} : options[:live_preview]
       @branch = options[:branch].nil? ? "" : options[:branch]
       @proxy_details = options[:proxy].nil? ? "" : options[:proxy]
+      @timeout = options[:timeout].nil? ? 3000 : options[:timeout]
+      @retryDelay = options[:retryDelay].nil? ? 3000 : options[:retryDelay]
+      @retryLimit = options[:retryLimit].nil? ? 5 : options[:retryLimit]
+      @errorRetry = options[:errorRetry].nil? ? [408, 429] : options[:errorRetry]
+      retry_options = {
+        "timeout" =>  @timeout.to_s,
+        "retryDelay"=>  @retryDelay,
+        "retryLimit"=> @retryLimit,
+        "errorRetry" => @errorRetry
+      }
       raise Contentstack::Error.new("Proxy URL Should not be Empty") if @proxy_details.present? && @proxy_details[:url].empty?
       raise Contentstack::Error.new("Proxy Port Should not be Empty") if @proxy_details.present? && @proxy_details[:port].empty?
-      API.init_api(api_key, delivery_token, environment,  @host, @branch, @live_preview, @proxy_details)
+      API.init_api(api_key, delivery_token, environment,  @host, @branch, @live_preview, @proxy_details, retry_options)
     end
 
     def content_types