ecoportal-api 0.10.2 → 0.10.4

data/lib/ecoportal/api/v1.rb

@@ -46,6 +46,5 @@ 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.2'.freeze
+    VERSION = '0.10.4'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.10.4
 platform: ruby
 authors:
 - Tapio Saarinen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-27 00:00:00.000000000 Z
+date: 2024-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -180,6 +180,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '6'
+- !ruby/object:Gem::Dependency
+  name: rate_throttle_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 description:
 email:
 - tapio@ecoportal.co.nz
@@ -209,12 +223,18 @@ files:
 - lib/ecoportal/api/common/batch_operation.rb
 - lib/ecoportal/api/common/batch_response.rb
 - lib/ecoportal/api/common/client.rb
+- lib/ecoportal/api/common/client/elastic_apm_integration.rb
+- lib/ecoportal/api/common/client/error.rb
+- lib/ecoportal/api/common/client/error/checks.rb
+- lib/ecoportal/api/common/client/rate_throttling.rb
+- lib/ecoportal/api/common/client/throughput.rb
+- lib/ecoportal/api/common/client/throughput/stats.rb
+- lib/ecoportal/api/common/client/time_out.rb
+- lib/ecoportal/api/common/client/with_retry.rb
 - lib/ecoportal/api/common/doc_helpers.rb
-- lib/ecoportal/api/common/elastic_apm_integration.rb
 - 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
@@ -236,7 +256,9 @@ 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/job.rb
+- lib/ecoportal/api/v1/job/awaiter.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

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

@@ -1,112 +0,0 @@
-require 'elastic-apm'
-module Ecoportal
-  module API
-    module Common
-      module ElasticApmIntegration
-
-        class UnexpectedServerError < StandardError
-          def initialize(code, msg)
-            super("Code: #{code} -- Error: #{msg}")
-          end
-        end
-
-        APM_SERVICE_NAME = 'ecoportal-api-gem'
-
-        # Log only errors that are only server's responsibility
-        def log_unexpected_server_error(response)
-          raise "Expecting Ecoportal::API::Common::Response. Given: #{response.class}" unless response.is_a?(Common::Response)
-          return nil unless elastic_apm_service
-          return nil unless unexpected_server_error?(response.status)
-          if ElasticAPM.running?
-            ElasticAPM.report(UnexpectedServerError.new(response.status, response.body))
-          end
-        end
-
-        private
-
-        def unexpected_server_error?(code)
-          !code || ((code >= 500) && (code <= 599)) || (code <= 99)
-        end
-
-        # finalizer to stop the agent
-        close_elastic_apm = Proc.new do |id|
-          begin
-            if ElasticAPM.running?
-              puts "Stopping ElasticAPM service"
-              ElasticAPM.stop
-            end
-          rescue StandardError => e
-            # Silent
-          end
-        end
-        ObjectSpace.define_finalizer("ElasticAPM", close_elastic_apm)
-
-        def elastic_apm_service
-          return false if @disable_apm
-          begin
-            ElasticAPM.start(**elastic_apm_options) unless ElasticAPM.running?
-          rescue StandardError => e
-            @disable_apm = true
-            puts "ElasticAPM services not available: #{e}"
-          end
-        end
-
-        def elastic_apm_options
-          {
-            service_name: APM_SERVICE_NAME,
-            server_url:   elastic_apm_url,
-            secret_token: elastic_apm_key,
-            environment:  environment,
-            #http_compression: false,
-            transaction_sample_rate:  0.1,
-            transaction_max_spans:    100,
-            span_frames_min_duration: "5ms"
-          }.tap do |options|
-            options.merge!({
-              log_level: Logger::DEBUG,
-              log_path:  File.join(__dir__, "elastic_apm.log")
-            }) if false
-          end
-        end
-
-        def elastic_apm_url
-          @elastic_apm_url ||= "https://".tap do |url|
-            url << "#{elastic_apm_account_id}"
-            url << ".#{elastic_apm_base_url}"
-            url << ":#{elastic_apm_port}"
-          end
-        end
-
-        def elastic_apm_key
-          @elastic_apm_key ||= ENV['ELASTIC_APM_KEY']
-        end
-
-        def elastic_apm_account_id
-          @elastic_apm_account_id ||= ENV['ELASTIC_APM_ACCOUNT_ID']
-        end
-
-        def elastic_apm_base_url
-          @elastic_apm_base_url ||= "apm.#{elastic_apm_region}.aws.cloud.es.io"
-        end
-
-        def elastic_apm_region
-          @elastic_apm_region ||= ENV['ELASTIC_APM_REGION'] || "ap-southeast-2"
-        end
-
-
-        def elastic_apm_port
-          @elastic_apm_port ||= ENV['ELASTIC_APM_PORT'] || "443"
-        end
-
-        def environment
-          @environment ||= "unknown".tap do |value|
-            if instance_variable_defined?(:@host) && env = @host.gsub(".ecoportal.com", '')
-              value.clear << env
-            end
-          end
-        end
-
-      end
-    end
-  end
-end

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

@@ -1,26 +0,0 @@
-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/v1/job_status.rb

@@ -1,33 +0,0 @@
-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