ecoportal-api 0.10.1 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84d530d29757e28159e985e70e8a0da65f16d831ea2658fcafbe94f42e98f882
-  data.tar.gz: a4778b377de727e3c648fa79d674b044b32d452c7cc4f024d5fbb383185a3097
+  metadata.gz: 4cc0547ca88715ad6b0f2d3bc7ed4661bab0f9259117ce28aa5d43aab0761d02
+  data.tar.gz: 1e109b427a0e71bd91edf1d4e9ce6e7cf9ac2df998662c97746df30b8e07998b
 SHA512:
-  metadata.gz: cb0dad40ddd3d5b0b621ff61b063bf2e92522b09156035009a15e782d946d43aa9db28c0066c3db1c805c78f29a2ee550fd7c358020b7216a776624c3d31f43e
-  data.tar.gz: c84332d17ddd19fbfbbd69f287c2110cad88064ebce801f232fcaeeccc5e6db5ec2c5ce359267d43df6bd8f4bf08238b0c242f30ef39789b92321030a914b09f
+  metadata.gz: 44eba3743e30beff3c04e71b1191900b8477d81af1371f1a5003cb6847384e384d535e51390e4f8db39e8aa81a0cbf7fc200a87ac18036c45e56530b72b09342
+  data.tar.gz: 1749045310b0748e8935027cd0d1b9d69e7a84c4534b27017bd1581848d579c6359e59dedfe19e3cbe451038e2a4c70fb82150a01ca4c9260eadde64bfac5a92

data/.rubocop.yml

@@ -30,6 +30,11 @@ Style/ConditionalAssignment:
 Style/BlockDelimiters:
   BracesRequiredMethods: ['log']
   AllowedPatterns: ['proc', 'new']
+Style/HashSyntax:
+  EnforcedShorthandSyntax: either
+  EnforcedStyle: no_mixed_keys
+Style/ArgumentsForwarding:
+  UseAnonymousForwarding: false
 Style/ClassAndModuleChildren:
   Enabled: false
 Style/FrozenStringLiteralComment:
@@ -93,3 +98,5 @@ Naming/MethodParameterName:
   AllowedNames: ['x', 'y', 'i', 'j', 'id', 'io', 'to']
 Naming/RescuedExceptionsVariableName:
   Enabled: false
+Naming/BlockForwarding:
+  Enabled: false

data/CHANGELOG.md

@@ -2,19 +2,37 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.10.3] - 2024-09-xx
+
+### Added
+
+### Changed
+
+### Fixed
+
+## [0.10.2] - 2024-09-27
+
+### Added
+
+- `Ecoportal::API::Common::TimeOut` to calculate adaptive time outs.
+
+### Changed
+
+- `Ecoportal::API::V1::Person#job`
+  - added **adaptative await**
+  - evaluate `true` to `complete?` if `progress` is that of total count.
+
 ## [0.10.1] - 2024-08-01
 
 ### Added
 
-- `Ecoportal::V1::Person#brand_id`
-- `Ecoportal::V1::Person#archived`
+- `Ecoportal::API::V1::Person#brand_id`
+- `Ecoportal::API::V1::Person#archived`
 
 ### Changed
 
 - require `ruby 3`
 
-### Fixed
-
 ## [0.9.8] - 2024-05-15
 
 ### Added
@@ -344,5 +362,3 @@ All notable changes to this project will be documented in this file.
 
 - this `CHANGELOG.md` file
 - person model: `freemium` core property
-
-

data/ecoportal-api.gemspec

@@ -1,12 +1,17 @@
+# rubocop:disable Gemspec/DevelopmentDependencies
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "ecoportal/api/version"
+
+require 'ecoportal/api/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "ecoportal-api"
   spec.version       = Ecoportal::API::VERSION
-  spec.authors       = ["Tapio Saarinen"]
-  spec.email         = ["tapio@ecoportal.co.nz", "rien@ecoportal.co.nz", "oscar@ecoportal.co.nz", "bozydar@ecoportal.co.nz"]
+  spec.authors       = ['Tapio Saarinen']
+  spec.email         = [
+    'tapio@ecoportal.co.nz',
+    'oscar@ecoportal.co.nz'
+  ]
 
   spec.summary       = %q{A collection of helpers for interacting with the ecoPortal MS's various APIs}
   spec.homepage      = "https://www.ecoportal.com"
@@ -19,17 +24,21 @@ Gem::Specification.new do |spec|
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "rspec",     ">= 3.12.0", "< 4"
-  spec.add_development_dependency "rake",      ">= 13.1.0", "< 14"
-  spec.add_development_dependency "yard",      ">= 0.9.34", "< 1"
-  spec.add_development_dependency "redcarpet", ">= 3.6.0",  "< 4"
-  spec.add_development_dependency "pry"      , "~> 0.14"
+  spec.add_development_dependency 'pry'      , '~> 0.14'
+  spec.add_development_dependency 'rake',      '>= 13.0.3', '< 14'
+  spec.add_development_dependency 'redcarpet', '>= 3.6.0',  '< 4'
+  spec.add_development_dependency 'rspec',     '>= 3.12.0', '< 4'
+  spec.add_development_dependency 'rubocop',   '~> 1'
+  spec.add_development_dependency 'rubocop-rake', '~> 0'
+  spec.add_development_dependency 'yard',      '~> 0.9'
 
   spec.add_dependency 'dotenv',        '~> 3'
   spec.add_dependency 'elastic-apm',   '>= 4.7',   "< 5"
   spec.add_dependency 'http',          '~> 5.1',   "< 6"
 end
+
+# rubocop:enable Gemspec/DevelopmentDependencies

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

@@ -11,6 +11,10 @@ module Ecoportal
           @logger     = logger
         end
 
+        def count
+          @operations.count
+        end
+
         def as_json
           {
             actions: @operations.map do |operation|

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

@@ -12,7 +12,7 @@ module Ecoportal
             doc
           end
         end
-        
+
         def get_id(doc)
           id = nil
           id ||= doc.id if doc.respond_to?(:id)

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

@@ -0,0 +1,26 @@
+module Ecoportal
+  module API
+    module Common
+      module TimeOut
+        MIN_THROUGHPUT = 0.2 # people per second
+        MIN_SIZE       = 10
+
+        private
+
+        def min_throughput
+          self.class::MIN_THROUGHPUT
+        end
+
+        def min_size
+          self.class::MIN_SIZE
+        end
+
+        def timeout_for(count)
+          count = 1        unless count&.positive?
+          count = min_size if count < min_size
+          (count.ceil / min_throughput).ceil
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/common.rb

@@ -11,6 +11,7 @@ require 'ecoportal/api/common/base_model'
 require 'ecoportal/api/common/doc_helpers'
 require 'ecoportal/api/common/logging'
 require 'ecoportal/api/common/elastic_apm_integration'
+require 'ecoportal/api/common/time_out'
 require 'ecoportal/api/common/client'
 require 'ecoportal/api/common/response'
 require 'ecoportal/api/common/wrapped_response'

data/lib/ecoportal/api/v1/job_status.rb

@@ -0,0 +1,33 @@
+module Ecoportal
+  module API
+    class V1
+      class JobStatus
+        attr_reader :id, :progress
+
+        def initialize(id, complete, errored, progress)
+          @id       = id
+          @complete = complete
+          @errored  = errored
+          @progress = progress
+        end
+
+        def complete?(total = nil)
+          return @complete if total.nil?
+
+          progress >= total
+        end
+
+        def errored?
+          @errored
+        end
+
+        def to_s
+          msg = complete? ? "Completed" : "In progress"
+          msg = "Errored" if errored?
+          msg << " with #{progress} done."
+          msg
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/v1/people.rb

@@ -6,9 +6,9 @@ module Ecoportal
       class People
         extend Common::BaseClass
         include Common::DocHelpers
+        include Common::TimeOut
         include Enumerable
 
-        JOB_TIMEOUT        = 240
         DELAY_STATUS_CHECK = 5
 
         class_resolver :person_class, "Ecoportal::API::V1::Person"
@@ -169,15 +169,20 @@ module Ecoportal
 
           yield operation
 
-          job_id = create_job(operation)
-          status = wait_for_job_completion(job_id)
+          total   = operation.count
+          timeout = timeout_for(total)
 
-          if status&.complete?
+          job_id  = create_job(operation)
+          status  = wait_for_job_completion(job_id, timeout: timeout, total: total)
+
+          # @todo
+          # if total == status.progress
+          if status&.complete?(total)
             job_result(job_id, operation)
           else
-            msg  = "Job `#{job_id}` not complete. "
-            msg << "Probably timeout after #{JOB_TIMEOUT} seconds. "
-            msg << "Current status: #{status}"
+            msg  = "Job '#{job_id}' not complete (size: #{total}).\n"
+            msg << "  Probably timeout after #{timeout} seconds.\n"
+            msg << "  Current status: #{status}"
 
             raise API::Errors::TimeOut, msg
           end
@@ -191,8 +196,6 @@ module Ecoportal
 
         private
 
-        JobStatus = Struct.new(:id, :complete?, :errored?, :progress)
-
         def job_status(job_id)
           response = client.get("/people/job/#{CGI.escape(job_id)}/status")
           body     = response && body_data(response.body)
@@ -201,12 +204,7 @@ module Ecoportal
           msg     << "Errors: #{body}"
           raise msg unless response.success?
 
-          JobStatus.new(
-            body["id"],
-            body["complete"],
-            body["errored"],
-            body["progress"]
-          )
+          JobStatus.new(*body.values_at(*%w[id complete errored progress]))
         end
 
         # @return [Ecoportal::API::Common::Response] the results of the batch job
@@ -216,15 +214,25 @@ module Ecoportal
           end
         end
 
-        def wait_for_job_completion(job_id)
+        def wait_for_job_completion(job_id, timeout:, total:)
           # timeout library is evil. So we make poor-man timeout.
           # https://jvns.ca/blog/2015/11/27/why-rubys-timeout-is-dangerous-and-thread-dot-raise-is-terrifying/
           before = Time.now
 
           loop do
             status = job_status(job_id)
-            break status if status.complete?
-            break status if Time.now >= before + JOB_TIMEOUT
+            break status if status.complete?(total)
+
+            left = (before + timeout) - Time.now
+            break status unless left.positive?
+            # break status if Time.now >= before + timeout
+
+            msg  = " ... Await job "
+            msg << "('#{job_id}'; done: #{status.progress}): "
+            msg << "#{left.ceil} sec.    \r"
+
+            print msg
+            $stdout.flush
 
             sleep(DELAY_STATUS_CHECK)
             status

data/lib/ecoportal/api/v1.rb

@@ -46,5 +46,6 @@ module Ecoportal
   end
 end
 
+require 'ecoportal/api/v1/job_status'
 require 'ecoportal/api/v1/person_schemas'
 require 'ecoportal/api/v1/people'

data/lib/ecoportal/api/version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    VERSION = "0.10.1".freeze
+    VERSION = '0.10.2'.freeze
   end
 end

metadata

@@ -1,42 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.10.2
 platform: ruby
 authors:
 - Tapio Saarinen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-01 00:00:00.000000000 Z
+date: 2024-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.12.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.12.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 13.1.0
+        version: 13.0.3
     - - "<"
       - !ruby/object:Gem::Version
         version: '14'
@@ -46,37 +40,37 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 13.1.0
+        version: 13.0.3
     - - "<"
       - !ruby/object:Gem::Version
         version: '14'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.34
+        version: 3.6.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.34
+        version: 3.6.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '4'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 3.12.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
@@ -86,24 +80,52 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 3.12.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -161,9 +183,7 @@ dependencies:
 description:
 email:
 - tapio@ecoportal.co.nz
-- rien@ecoportal.co.nz
 - oscar@ecoportal.co.nz
-- bozydar@ecoportal.co.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -194,6 +214,7 @@ files:
 - lib/ecoportal/api/common/hash_diff.rb
 - lib/ecoportal/api/common/logging.rb
 - lib/ecoportal/api/common/response.rb
+- lib/ecoportal/api/common/time_out.rb
 - lib/ecoportal/api/common/wrapped_response.rb
 - lib/ecoportal/api/errors.rb
 - lib/ecoportal/api/errors/base.rb
@@ -215,6 +236,7 @@ files:
 - lib/ecoportal/api/internal/schema_field_value.rb
 - lib/ecoportal/api/logger.rb
 - lib/ecoportal/api/v1.rb
+- lib/ecoportal/api/v1/job_status.rb
 - lib/ecoportal/api/v1/people.rb
 - lib/ecoportal/api/v1/person.rb
 - lib/ecoportal/api/v1/person_details.rb
@@ -243,7 +265,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.18
 signing_key:
 specification_version: 4
 summary: A collection of helpers for interacting with the ecoPortal MS's various APIs