ecoportal-api 0.10.6 → 0.10.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae05088d3d0542b2200a614b0043d8580cd713cbfcf4fb473b17be4f1930aafe
-  data.tar.gz: 90259cfa1c993c457b2bcfcd57d343538c7bf4f3746b21c921eb1be3e92dc370
+  metadata.gz: e7809f3ff8865db913a9f1c26d2884057d4f9a585d4919d17a61326e264ebe12
+  data.tar.gz: 8816f23d52faf898a04f80c8ba283cf428684d5b3ad67cddbb7178c1280e81e2
 SHA512:
-  metadata.gz: '058bd304110936dc08ee37c77c081b65fc08b68a29f60ff74ead0798e0894100a26f6a85b60ce4d38c447d74707f78eec55a69755002ec10c6b36b98f4db8b67'
-  data.tar.gz: 7340fe5e7875a9a2b3aefda197927fbfe733299c0dc0494b3b09b59db24ae7bac80b135ea0fb9fd1d7b5abc1ed246a715e3f3b14ee5d26e45a8bef2f14017815
+  metadata.gz: d6eb969d3965fc9d86eacd1fa941178ca678b81ab528aa5c0b703bdec2a27866f191172d5f077fcc77638f6a39faeb03ab9394a8a901ca8dee5f65b5ae1c9003
+  data.tar.gz: 22ed539fbf7cae6d9336efc1b0816d3142c4fe6f6155a8e0d57a986c199b668bf67e3b3481c91889ff8aa99b70168316be195d2fa0f3d371e9a310d015305135

data/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## [0.10.7] - 2024-10-xx
+## [0.10.9] - 2024-12-xx
 
 ### Added
 
@@ -10,6 +10,30 @@ All notable changes to this project will be documented in this file.
 
 ### Fixed
 
+## [0.10.8] - 2024-12-xx
+
+### Changed
+
+- `Ecoportal::API::Common::BaseModel` tidy up code
+
+### Fixed
+
+- `Ecoportal::API::V1::Job::Awaiter::Timer#time_left`
+  - To include `time_left_to_start` when not started.
+- Remove call to `byebug`
+
+## [0.10.7] - 2024-11-21
+
+### Changed
+
+- Remove unused code
+- `Ecoportal::API::Common::Client.new` the `version` argument doesn't default to `v1` but to `nil`.
+
+### Fixed
+
+- A couple of errors
+- Remove missing api key error log when no client `version` is specified.
+
 ## [0.10.6] - 2024-10-28
 
 ### Added

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

@@ -17,9 +17,11 @@ module Ecoportal
           def passthrough(*methods, to: :doc)
             methods.each do |method|
               method = method.to_s
+
               define_method method do
                 send(to)[method]
               end
+
               define_method "#{method}=" do |value|
                 send(to)[method] = value
               end
@@ -36,6 +38,7 @@ module Ecoportal
                 value = instance_variable_get(var)
                 return value unless nullable
                 return value if (value && doc[key]) || (!value && !doc[key])
+
                 remove_instance_variable(var)
               end
 
@@ -44,8 +47,12 @@ module Ecoportal
               return instance_variable_set(var, nil) unless doc[key]
 
               self.class.resolve_class(klass).new(
-                doc[key], parent: self, key: key
-              ).tap {|obj| instance_variable_set(var, obj)}
+                doc[key],
+                parent: self,
+                key:    key
+              ).tap do |obj|
+                instance_variable_set(var, obj)
+              end
             end
           end
         end
@@ -119,12 +126,16 @@ module Ecoportal
         end
 
         def dirty?
-          as_update != {}
+          return false unless (json = as_update)
+          return false unless json.is_a?(Hash)
+
+          !json.empty?
         end
 
         # It consolidates all the changes carried by `doc` by setting it as `original_doc`.
         def consolidate!
-          raise UnlinkedModel.new(from: "#{self.class}#consolidate!", key: _key) unless linked?
+          err = UnlinkedModel.new(from: "#{self.class}##{__method__}", key: _key)
+          raise err unless linked?
 
           new_doc = JSON.parse(doc.to_json)
           if is_root?
@@ -143,7 +154,9 @@ module Ecoportal
         def reset!(key = nil) # rubocop:disable Metrics/AbcSize>
           msg = "'key' should be a String. Given #{key}"
           raise ArgumentError, msg unless !key || key.is_a?(String)
-          raise UnlinkedModel.new(from: "#{self.class}#reset!", key: _key) unless linked?
+
+          err = UnlinkedModel.new(from: "#{self.class}##{__method__}", key: _key)
+          raise err unless linked?
 
           if key
             if respond_to?(key) && (child = send(key)) && child.is_a?(Ecoportal::API::Common::BaseModel)
@@ -156,6 +169,7 @@ module Ecoportal
             end
           else
             new_doc = JSON.parse(original_doc.to_json)
+
             if is_root?
               @doc = new_doc
             else

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

@@ -61,10 +61,10 @@ module Ecoportal
             }.tap do |options|
               # next unless false
 
-              options.merge!({
-                log_level: Logger::DEBUG,
-                log_path:  File.join(__dir__, "elastic_apm.log")
-              })
+              # options.merge!({
+              #   log_level: ::Logger::DEBUG,
+              #   log_path:  File.join('log', "elastic_apm.log")
+              # })
             end
           end
 

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

@@ -28,7 +28,7 @@ module Ecoportal
                 msg  = "Received non json body in response "
                 msg << "(#{response.src_body.class}):\n "
                 msg << response.src_body
-                puts
+                puts msg
               end
             end
           end

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

@@ -47,7 +47,7 @@ module Ecoportal
               log_unexpected_server_error(response)
 
               msg  = "Got server error (#{response.status}): #{response.body}\n"
-              msg << "Going to retry (##{i} of #{attempts})"
+              msg << "Going to retry (##{i + 1} of #{attempts})"
               log(:debug) { msg }
 
               sleep(delay) if i < attempts

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

@@ -39,7 +39,7 @@ module Ecoportal
         # @param logger [Logger] an object with `Logger` interface to generate logs.
         # @param deep_logging [Boolean] whether or not batch responses should be logged
         # @return [Client] an object that holds the configuration of the api connection.
-        def initialize(api_key:, version: "v1", host: DEFAULT_HOST, logger: nil, deep_logging: false)
+        def initialize(api_key:, version: nil, host: DEFAULT_HOST, logger: nil, deep_logging: false)
           @version      = version
           @api_key      = api_key
           @logger       = logger
@@ -59,6 +59,7 @@ module Ecoportal
           end
 
           return unless @api_key.nil? || @api_key.match(/\A\W*\z/)
+          return unless version
 
           log(:error) { "Api-key missing!" }
         end

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

@@ -2,7 +2,6 @@ module Ecoportal
   module API
     module Common
       module DocHelpers
-
         def get_body(doc)
           if doc.respond_to?(:as_update)
             doc.as_update

data/lib/ecoportal/api/v1/job/awaiter/timer.rb

@@ -21,11 +21,7 @@ module Ecoportal
             end
 
             alias_method :original_start, :start
-            # `start` time only counts from the moment that
-            # it already started to progress
             def start
-              return timestamp unless lstatus&.started?
-
               original_start || timestamp
             end
 
@@ -76,6 +72,10 @@ module Ecoportal
             end
 
             def time_left
+              (timeout_in - waited).round(2)
+            end
+
+            def time_left_total
               (timeout - waited).round(2)
             end
 
@@ -86,7 +86,7 @@ module Ecoportal
             end
 
             def timeout_in
-              return time_left if started?
+              return time_left_total if started?
 
               time_left_to_start
             end
@@ -94,7 +94,7 @@ module Ecoportal
             # 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/
             def timeout?
-              !time_left.positive?
+              !time_left_total.positive?
             end
 
             def start_timeout?
@@ -140,7 +140,8 @@ module Ecoportal
               %i[total timeout start].each_with_object({}) do |key, kargs|
                 kargs[key] = send(key)
               end.tap do |kargs|
-                kargs[:start]   = timestamp
+                kargs[:start]   = start
+                kargs[:last]    = timestamp
                 kargs[:lstatus] = status
               end
             end

data/lib/ecoportal/api/version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    VERSION = '0.10.6'.freeze
+    VERSION = '0.10.8'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api
 version: !ruby/object:Gem::Version
-  version: 0.10.6
+  version: 0.10.8
 platform: ruby
 authors:
 - Tapio Saarinen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-28 00:00:00.000000000 Z
+date: 2024-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -289,7 +289,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: A collection of helpers for interacting with the ecoPortal MS's various APIs