ecoportal-api 0.9.7 → 0.9.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5696bb0c226299139a1c081ec5de3c041fdd252d76ca56ff45479c78e53c84c5
-  data.tar.gz: 987ec0d24a1ee340b2b9cb8b68dd575eb1a5f0110d4a18c653d61c9145d320b9
+  metadata.gz: d89b2ca34f7a85f9cbeaf61331b155fb83b4f80ee8ff9d57133837d4f87bf03f
+  data.tar.gz: 93e71b77a46c283f01708f94099580774cf5d72b49df2041e15688f9622dfe08
 SHA512:
-  metadata.gz: 85151476e47a2bfd61e0396e31d48dea0fb36053506c29dac394012d81986cd800476c06891eff5512166b26ca6a98513679a84d77227813807c65d80ab4ad2f
-  data.tar.gz: d36fb967335bed2db35afec997bc842cd6b660e251e0a9fa34f7b35adb4649a2410c2d1a73572c32c388878baa84c62d3ada9237702e9ffab70cd7719cd964b6
+  metadata.gz: c2f5a46fb757bebae8ac0727ce9ea89d801e5fb3b91aac3146b2117c43f852682ed7bbd3ca7020b43ddde5b1ccdd4c4297bf52afa0fa5a859def1701844caedc
+  data.tar.gz: 4b1fc568bae19759bac6d62badf06a9a949988b7667e87e8b2ec0ab90b5604d67e33ea695117d43bfa329d1706c81bf8fa7244323264052205b49b01bd38c233

data/.rubocop.yml

@@ -1,39 +1,71 @@
 AllCops:
-  TargetRubyVersion: 2.5.1
+  TargetRubyVersion: 2.7.8
   Exclude:
     - 'config/routes.rb'
+  NewCops: enable
 
-Metrics/LineLength:
-  Enabled: false
-Metrics/BlockLength:
-  ExcludedMethods: [context, describe]
-  Max: 50
+Metrics/ClassLength:
+  Max: 500
+Metrics/ModuleLength:
+  Max: 300
 Metrics/MethodLength:
   Max: 50
-Metrics/ClassLength:
-  Max: 200
 Metrics/AbcSize:
   Max: 30
-
-ParameterLists:
+Metrics/ParameterLists:
   Max: 5
   CountKeywordArgs: false
+Metrics/BlockLength:
+  CountAsOne: ['array', 'heredoc', 'method_call']
+  Max: 50
+Metrics/CyclomaticComplexity:
+  Max: 30
+Metrics/PerceivedComplexity:
+  Max: 30
 
-Style/StringLiterals:
+Style/AccessorGrouping:
+  Enabled: false
+Style/ConditionalAssignment:
+  Enabled: false
+Style/BlockDelimiters:
+  BracesRequiredMethods: ['log']
+  AllowedPatterns: ['proc', 'new']
+Style/ClassAndModuleChildren:
   Enabled: false
 Style/FrozenStringLiteralComment:
   Enabled: false
-Style/CommentedKeyword:
+Style/StringLiterals:
   Enabled: false
-Style/MultilineBlockChain:
+Style/StringLiteralsInInterpolation:
   Enabled: false
 Style/Documentation:
   Enabled: false
-Style/StringLiteralsInInterpolation:
+Style/CommentedKeyword:
+  Enabled: false
+Style/MultilineBlockChain:
   Enabled: false
 Style/AndOr:
   Enabled: false
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+Style/FetchEnvVar:
+  Enabled: false
+Style/RegexpLiteral:
+  EnforcedStyle: mixed
+  AllowInnerSlashes: true
 
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+Layout/LeadingCommentSpace:
+  Enabled: false
+  AllowGemfileRubyComment: true
+Layout/ParameterAlignment:
+  Enabled: false
+Layout/MultilineMethodDefinitionBraceLayout:
+  EnforcedStyle: symmetrical
+Layout/LineLength:
+  Enabled: true
 Layout/SpaceInsideHashLiteralBraces:
   Enabled: false
 Layout/SpaceInsideBlockBraces:
@@ -42,14 +74,22 @@ Layout/SpaceAroundOperators:
   Enabled: false
 Layout/ExtraSpacing:
   AllowForAlignment: true
+  AllowBeforeTrailingComments: true
 Layout/AccessModifierIndentation:
   EnforcedStyle: indent
 Layout/DotPosition:
   EnforcedStyle: trailing
 Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented
-Layout/IndentHash:
+Layout/FirstHashElementIndentation:
+  Enabled: false
+Layout/EmptyLineAfterGuardClause:
   Enabled: false
 
 Naming/VariableNumber:
   EnforcedStyle: snake_case
+  CheckSymbols: false
+Naming/MethodParameterName:
+  AllowedNames: ['x', 'y', 'i', 'j', 'id', 'io', 'to']
+Naming/RescuedExceptionsVariableName:
+  Enabled: false

data/CHANGELOG.md

@@ -1,6 +1,17 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [0.9.8] - 2024-05-15
+
+### Added
+  - `rubocop`
+
+### Changed
+  - `Ecoportal::API::Common::Client#with_retry`
+    - Make resilient (**re-try**) to recent silent server errors where the body doesn't parse as JSON.
+
+### Fixed
+
 ## [0.9.7] - 2024-02-03
 
 ### Added
@@ -8,8 +19,6 @@ All notable changes to this project will be documented in this file.
   - `Ecoportal::API::V1::Person`
     - **removed** property `subordinates`
 
-### Fixed
-
 ## [0.9.6] - 2024-02-03
 
 ### Changed

data/Rakefile

@@ -1,7 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require "yard"
-require "redcarpet"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'yard'
+require 'redcarpet'
 
 desc "run the specs"
 RSpec::Core::RakeTask.new(:spec)
@@ -10,11 +11,18 @@ desc "run rspec showing backtrace"
 RSpec::Core::RakeTask.new(:spec_trace) do |task|
   task.rspec_opts = ['--backtrace']
 end
+task(rspec_trace: :spec_trace)
 
 desc "run rspec stopping on first fail, and show backtrace"
 RSpec::Core::RakeTask.new(:spec_fast) do |task|
   task.rspec_opts = ['--fail-fast', '--backtrace']
 end
+task(rspec_fast: :spec_fast)
+
+desc "run rubocop diaplying cop names"
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.options = ['--display-cop-names']
+end
 
 # default task name is yard
 desc "Yard: generate all the documentation"
@@ -22,6 +30,9 @@ YARD::Rake::YardocTask.new(:doc) do |t|
   #t.files = ['lib/**/*.rb']
 end
 
-task :default     => [:spec]
-task :rspec_trace => :spec_trace
-task :rspec_fast  => :spec_fast
+desc "default task: runs rubocop and rspec"
+task :default do
+  Rake::Task[:rubocop].invoke
+ensure
+  Rake::Task[:spec].invoke
+end

data/lib/ecoportal/api/common/client.rb

@@ -13,6 +13,7 @@ module Ecoportal
       class Client
         include Common::ElasticApmIntegration
         DELAY_REQUEST_RETRY = 5
+        RETRY_ATTEMPTS      = 5
 
         attr_accessor :logger
         attr_reader :host
@@ -167,22 +168,27 @@ module Ecoportal
         end
 
         # Helper to ensure unexpected server errors do not bring client scripts immediately down
-        def with_retry(attempts = 3, delay = DELAY_REQUEST_RETRY, error_safe: true, &block)
+        def with_retry(attempts = RETRY_ATTEMPTS, delay = DELAY_REQUEST_RETRY, error_safe: true, &block)
           response = nil
           attempts.times do |i|
             remaining = attempts - i - 1
+
             begin
               response = block.call
             rescue HTTP::ConnectionError => e
-              raise unless error_safe && remaining > 0
+              raise unless error_safe && remaining.positive?
               log(:error) { "Got connection error: #{e.message}" }
               response = with_retry(remaining, error_safe: error_safe, &block)
             rescue IOError => e
-              raise unless error_safe && remaining > 0
+              raise unless error_safe && remaining.positive?
               log(:error) { "Got IO error: #{e.message}" }
               response = with_retry(remaining, error_safe: error_safe, &block)
             end
-            return response unless unexpected_server_error?(response.status)
+
+            return response unless some_unexpected_error?(response)
+
+            puts "re-attempting (remaining: #{remaining} attempts out of #{attempts})"
+
             log_unexpected_server_error(response)
             msg  = "Got server error (#{response.status}): #{response.body}\n"
             msg += "Going to retry (#{i} out of #{attempts})"
@@ -192,6 +198,22 @@ module Ecoportal
           response
         end
 
+        # Sometimes response body is wrong but status code
+        # doesn't reflect. Let it retry
+        def some_unexpected_error?(response)
+          unexpected_server_error?(response.status) ||
+            unexpected_body?(response)
+        end
+
+        def unexpected_body?(response)
+          response.body.nil?.tap do |wrong|
+            next unless wrong
+
+            msg  = "Received non json body in response "
+            msg << "(#{response.src_body.class}):\n #{response.src_body}"
+            puts
+          end
+        end
       end
     end
   end

data/lib/ecoportal/api/common/response.rb

@@ -2,18 +2,18 @@ module Ecoportal
   module API
     module Common
       class Response
-
         attr_reader :status, :body
+        attr_reader :src_body
 
         def initialize(response)
-          @status = response.status
-          @body   = [].tap do |body_data|
+          @status   = response.status
+          @src_body = [].tap do |body_data|
             response.body.each do |chunk|
               body_data << chunk
             end
-          end.join("")
-          @body   = JSON.parse(@body.to_s) rescue nil
-          response
+          end.join.to_s
+
+          @body = JSON.parse(@src_body) rescue nil
         end
 
         def success?

data/lib/ecoportal/api/version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    VERSION = "0.9.7"
+    VERSION = "0.9.8".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api
 version: !ruby/object:Gem::Version
-  version: 0.9.7
+  version: 0.9.8
 platform: ruby
 authors:
 - Tapio Saarinen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-06 00:00:00.000000000 Z
+date: 2024-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler