QNE 0.4.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08af2240c5e32d2f70556448cfdfad22426d92148d3201ff00d9245cb28044cb'
-  data.tar.gz: b1c2cef04320bf582664ee675c0fbdb674a56afa8503c8e3cc456e7e5ef165e8
+  metadata.gz: 5a03fcd46a6306a4b0e8e18433b0d60cdaaea726c28e0123c98d81f419a4bcfa
+  data.tar.gz: 28dee7da9e164b9c25d3daf21ed1764922ba1ffc3f61148babb70653de140e57
 SHA512:
-  metadata.gz: 13fd75a27ded11b6951ce4ebcedf31bd1a12f440afba44efafc4a54b23e1eb2675a87c87f66aa0bc7ba2fabdb6478910ae0d376b939d9119177e68639816b68d
-  data.tar.gz: 4ec19df06acf1d594bb0263f43996b264fb99675c383628d3000aa80b45f564b072b3084a749eb7cd889cf3bc3cd9ea738d0ee1123ae42585abac4d8ca382257
+  metadata.gz: 28554d4627be68ffd0e94353c7c15763d8286fdc2bbeaf76401aecaadc8792bd71bb6f4f0b51bdafbb894b0d842e50b94a84272adf2bc947365b7495e9a2f644
+  data.tar.gz: b56aea0997738e4f4ef37d4441fb5dfe6c6995aa81aa330ee3cb2cca63a6e71ed17c45e843a6e6f6821661d68ed019693b80fafdcb95caccee5711b1dc2d870b

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
   TargetRubyVersion: 2.5
+  SuggestExtensions: false
 
 Style/StringLiterals:
   Enabled: true
@@ -21,4 +22,9 @@ Style/Documentation:
   Enabled: false
 
 Naming/FileName:
-  Enabled: false
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  Exclude:
+    - 'Gemfile'

data/Gemfile

@@ -1,12 +1,11 @@
-# frozen_string_literal: true
-
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in QNE.gemspec
 gemspec
 
+gem 'faraday-net_http_persistent', '~> 2.3'
+gem 'faraday-retry', '~> 2.3'
+gem 'net-http-persistent', '~> 4.0'
 gem 'rake', '~> 13.0'
-
 gem 'rspec', '~> 3.0'
-
 gem 'rubocop', '~> 1.21'

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    QNE (0.4.1)
+    QNE (0.5.1)
       faraday (>= 1.10)
       faraday-net_http_persistent (>= 1.2)
+      faraday-retry
       net-http-persistent (>= 4.0)
 
 GEM
@@ -27,6 +28,8 @@ GEM
     faraday-net_http_persistent (2.3.1)
       faraday (~> 2.5)
       net-http-persistent (>= 4.0.4, < 5)
+    faraday-retry (2.3.2)
+      faraday (~> 2.0)
     hashdiff (1.2.1)
     json (2.15.2)
     language_server-protocol (3.17.0.5)
@@ -89,6 +92,9 @@ PLATFORMS
 
 DEPENDENCIES
   QNE!
+  faraday-net_http_persistent (~> 2.3)
+  faraday-retry (~> 2.3)
+  net-http-persistent (~> 4.0)
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)

data/README.md

@@ -30,6 +30,23 @@ then you can use it to perform desired operation
 
 ```ruby
 conn.customers.all(top: 10) # returns top 10 customers
+
+# if you want to have a custom retry_block
+# the retry block will be executed before retry happens
+# for example i have a block for creating logs
+def create_logs
+  puts 'Error Occurred'.
+end
+
+def retry_block
+  proc { create_logs }
+end
+
+# so now when you establish the connection you will
+# pass the block in the qne_connection argument
+# # when farday occur and it reached the first retry
+# the block will be executed
+conn = @integration.qne_connection(retry_block)
 ```
 
 you can also check if the `db_code` is valid:

data/lib/QNE/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module QNE
-  VERSION = '0.4.1'
+  VERSION = '0.5.2'
 end

data/lib/QNE.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'faraday'
+require 'faraday/retry'
 require 'faraday/net_http_persistent'
 require_relative 'QNE/version'
 require_relative 'query_builder'
@@ -9,7 +9,5 @@ require_relative 'connection'
 
 module QNE
   class Error < StandardError; end
-  # Your code goes here...
-
   class UnathorizedError < Error; end
 end

data/lib/connection.rb

@@ -18,9 +18,11 @@ module QNE
   class Connection
     BASE_URI = 'https://dev-api.qne.cloud'
 
-    def initialize(options = {})
+    # You can provide your own block before executing retry function
+    def initialize(options = {}, &retry_block)
       @db_code = options.fetch(:db_code, nil) || ENV['QNE_DB_CODE']
       @api_token = options.fetch(:api_token, nil)
+      @retry_block = retry_block
     end
 
     def system_version
@@ -88,7 +90,10 @@ module QNE
     end
 
     def connection
-      @connection ||= Faraday.new(faraday_params)
+      @connection ||= Faraday.new(faraday_params) do |conn|
+        conn.request :retry, retry_options
+        conn.adapter Faraday.default_adapter
+      end
     end
 
     private
@@ -101,6 +106,17 @@ module QNE
       }
     end
 
+    def retry_options
+      @retry_options ||= {
+        retry_statuses: [401, 409, 500],
+        max: ENV.fetch('MAX_REQUEST_RETRY', '3').to_i, # total request will be made is 4
+        interval: ENV.fetch('INTERVAL_RETRY_NUMBER', '10').to_i, # interval each retry request
+        backoff_factor: 0,
+        exceptions: [Faraday::ResourceNotFound, Faraday::UnauthorizedError, Faraday::TimeoutError, Faraday::ConnectionFailed],
+        retry_block: @retry_block
+      }
+    end
+
     def auth_method
       @api_token ? bearer_auth : dbcode_auth
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: QNE
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Nujian Den Mark Meralpis
@@ -37,6 +37,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: net-http-persistent
   requirement: !ruby/object:Gem::Requirement