ecoportal-api 0.10.7 → 0.10.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7d949e504087bf41e30ba17c20425eea599e744aae98456ba943f4433dd819e
-  data.tar.gz: c382957de25cce7270caf6fa2615e731fc0aea94f67f43854ef339e97299461d
+  metadata.gz: 6237e3c50a3316623f664b2f3fda405a276f893371f8ba4f194584374d9ed90f
+  data.tar.gz: 0f071968a7b8daf694b4553b55187d8c411beea2902e86079e0a4c39cb8b3693
 SHA512:
-  metadata.gz: e0a7e3401365dff83f9b40aa6e11a812540748075dbce2592feac30c656096baa331817ba70b010cce951b5ca22f0abc12832192a144deff41ddc5f1cd1fc8cc
-  data.tar.gz: 6ac12ae619ce68ea87819b020b2745f9de443abc90b3985f68123291e419d18e4286a6a3ba41debbe2586856fea1eab46aac572e835bc38e4a14e9bbd1813b7a
+  metadata.gz: 67041fe9ebed8775b42189a2d4128b82653ccdb81edf22d8a8e9d66c95c771cf8c89b248cc2cb6c05e6801b3f67a6c444f0836848e17e236bf34fec0345374f0
+  data.tar.gz: 9fbb30e945184be0183a0280c61c7cedd8fc223806764de9dfaf000a135e37f00f9ceeab81f734e5c71e6ed101301e2c166a9392227322af468ec61408402725

data/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## [0.10.8] - 2024-11-xx
+## [0.10.10] - 2025-03-xx
 
 ### Added
 
@@ -10,6 +10,35 @@ All notable changes to this project will be documented in this file.
 
 ### Fixed
 
+## [0.10.9] - 2025-03-29
+
+### Added
+
+- `Ecoportal::API::V1::Person`, added usability methods:
+  - `#archived?`
+  - `archive!`
+  - `unarchive!`
+
+### Changed
+
+- Substantial code tidy up
+
+### Fixed
+
+- `Ecoportal::API::V1::PersonSchemas#each` called without block was loosing the parameters.
+
+## [0.10.8] - 2024-12-16
+
+### 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

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

@@ -8,25 +8,24 @@ module Ecoportal
         end
 
         def class_resolver(name, klass)
-          define_singleton_method(name) { resolve_class(klass) }
-          define_method(name) { self.class.resolve_class(klass) }
+          define_singleton_method(name) { resolve_class(klass)            }
+          define_method(name)           { self.class.resolve_class(klass) }
         end
 
         def resolve_class(klass)
-          @resolved ||= {}
+          @resolved        ||= {}
           @resolved[klass] ||=
             case klass
-              when Class
-                klass
-              when String
-                Kernel.const_get(klass)
-              when Symbol
-                resolve_class(self.send(klass))
-              else
-                raise "Unknown class: #{klass}"
+            when Class
+              klass
+            when String
+              Kernel.const_get(klass)
+            when Symbol
+              resolve_class(send(klass))
+            else
+              raise "Unknown class: #{klass}"
             end
         end
-
       end
     end
   end

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

@@ -4,7 +4,7 @@ module Ecoportal
     module Common
       class BaseModel
         class UnlinkedModel < StandardError
-          def initialize(msg = "Something went wrong when linking the document.", from: nil, key: nil)
+          def initialize(msg = 'Something went wrong when linking the document.', from: nil, key: nil)
             msg << " From: #{from}." if from
             msg << " key: #{key}."   if key
             super(msg)
@@ -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?
@@ -137,13 +148,15 @@ module Ecoportal
         # It removes all the changes carried by `doc` by restoring `original_doc` into `doc`.
         # @note
         #   1. When there are nullable properties, it may be required to apply `reset!` from the parent
-        #    i.e. `parent.reset!("child")` # when parent.child is `nil`
+        #    i.e. `parent.reset!('child')` # when parent.child is `nil`
         #   2. In such a case, only immediate childs are allowed to be reset
         # @param key [String, Array<String>, nil] if given, it only resets the specified property
-        def reset!(key = nil) # rubocop:disable Metrics/AbcSize>
+        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/batch_operation.rb

@@ -26,20 +26,20 @@ module Ecoportal
 
         def process_response(response)
           unless response.success?
-            msg = "Error: total failure in batch operation."
+            msg = 'Error: total failure in batch operation.'
             log(:debug) { msg }
             raise msg
           end
 
-          log(:debug) { "Processing batch responses" } if deep_logging?
+          log(:debug) { 'Processing batch responses' } if deep_logging?
 
           body_data(response.body).each.with_index do |subresponse, idx|
-            status   = subresponse["status"]
+            status   = subresponse['status']
             method   = @operations[idx][:method]
-            body     = subresponse["response"]
+            body     = subresponse['response']
             callback = @operations[idx][:callback]
 
-            if status == 200 && method == "GET"
+            if status == 200 && method == 'GET'
               batch_response = BatchResponse.new(status, body, @wrapper.new(body))
               log_batch_response(@operations[idx], batch_response)
 
@@ -57,7 +57,7 @@ module Ecoportal
           id = get_id(doc)
           @operations << {
             path:     "#{@base_path}/#{CGI.escape(id)}",
-            method:   "GET",
+            method:   'GET',
             callback: block
           }
         end
@@ -67,7 +67,7 @@ module Ecoportal
           body = get_body(doc)
           @operations << {
             path:     "#{@base_path}/#{CGI.escape(id)}",
-            method:   "PATCH",
+            method:   'PATCH',
             body:     body,
             callback: block
           }
@@ -78,7 +78,7 @@ module Ecoportal
           body = get_body(doc)
           @operations << {
             path:     "#{@base_path}/#{CGI.escape(id)}",
-            method:   "POST",
+            method:   'POST',
             body:     body,
             callback: block
           }
@@ -88,7 +88,7 @@ module Ecoportal
           id = get_id(doc)
           @operations << {
             path:     "#{@base_path}/#{CGI.escape(id)}",
-            method:   "DELETE",
+            method:   'DELETE',
             callback: block
           }
         end
@@ -97,7 +97,7 @@ module Ecoportal
           body = get_body(doc)
           @operations << {
             path:     @base_path,
-            method:   "POST",
+            method:   'POST',
             body:     body,
             callback: block
           }

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

@@ -22,7 +22,7 @@ module Ecoportal
           if success?
             each(&:print_pretty)
           else
-            puts "Request failed."
+            puts 'Request failed.'
           end
         end
       end

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

@@ -31,13 +31,13 @@ module Ecoportal
           close_elastic_apm = proc do |_id|
             next unless ElasticAPM.running?
 
-            puts "Stopping ElasticAPM service"
+            puts 'Stopping ElasticAPM service'
             ElasticAPM.stop
           rescue StandardError
             # Silent
           end
 
-          ObjectSpace.define_finalizer("ElasticAPM", close_elastic_apm)
+          ObjectSpace.define_finalizer('ElasticAPM', close_elastic_apm)
 
           def elastic_apm_service
             return false if @disable_apm
@@ -57,19 +57,19 @@ module Ecoportal
               # http_compression:        false,
               transaction_sample_rate:  0.1,
               transaction_max_spans:    100,
-              span_frames_min_duration: "5ms"
+              span_frames_min_duration: '5ms'
             }.tap do |options|
               # next unless false
 
               # options.merge!({
               #   log_level: ::Logger::DEBUG,
-              #   log_path:  File.join('log', "elastic_apm.log")
+              #   log_path:  File.join('log', 'elastic_apm.log')
               # })
             end
           end
 
           def elastic_apm_url
-            @elastic_apm_url ||= "https://".tap do |url|
+            @elastic_apm_url ||= 'https://'.tap do |url|
               url << elastic_apm_account_id.to_s
               url << ".#{elastic_apm_base_url}"
               url << ":#{elastic_apm_port}"
@@ -89,17 +89,17 @@ module Ecoportal
           end
 
           def elastic_apm_region
-            @elastic_apm_region ||= ENV['ELASTIC_APM_REGION'] || "ap-southeast-2"
+            @elastic_apm_region ||= ENV['ELASTIC_APM_REGION'] || 'ap-southeast-2'
           end
 
           def elastic_apm_port
-            @elastic_apm_port ||= ENV['ELASTIC_APM_PORT'] || "443"
+            @elastic_apm_port ||= ENV['ELASTIC_APM_PORT'] || '443'
           end
 
           def environment
-            @environment ||= "unknown".tap do |value|
+            @environment ||= 'unknown'.tap do |value|
               next unless instance_variable_defined?(:@host)
-              next unless (env = @host.gsub(".ecoportal.com", ''))
+              next unless (env = @host.gsub('.ecoportal.com', ''))
 
               value.clear << env
             end

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

@@ -25,7 +25,7 @@ module Ecoportal
               response.body.nil?.tap do |wrong|
                 next unless wrong
 
-                msg  = "Received non json body in response "
+                msg  = 'Received non json body in response '
                 msg << "(#{response.src_body.class}):\n "
                 msg << response.src_body
                 puts msg

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

@@ -40,7 +40,7 @@ module Ecoportal
               return response unless some_unexpected_error?(response)
 
               # handle server errors (5xx) & server bugs (i.e. empty body)
-              msg  = "re-attempting (remaining: "
+              msg  = 're-attempting (remaining: '
               msg << "#{remaining} attempts out of #{attempts})"
               log(:debug) { msg }
 

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

@@ -61,8 +61,7 @@ module Ecoportal
           return unless @api_key.nil? || @api_key.match(/\A\W*\z/)
           return unless version
 
-          byebug
-          log(:error) { "Api-key missing!" }
+          log(:error) { 'Api-key missing!' }
         end
 
         # Sends an http `GET` request against the api version using `path` to complete the base url,
@@ -74,7 +73,7 @@ module Ecoportal
         # @option params [String] :q some text to search. Omit this parameter to target all the entries.
         # @return [Common::Reponse] the basic custom response object.
         def get(path, params: {})
-          instrument("GET", path, params) do
+          instrument('GET', path, params) do
             request do |http|
               http.get(url_for(path), params: params)
             end
@@ -88,7 +87,7 @@ module Ecoportal
         # @param data [String] the body of the query in json format.
         # @return [Common::Reponse] the basic custom response object.
         def post(path, data:)
-          instrument("POST", path, data) do
+          instrument('POST', path, data) do
             request do |http|
               http.post(url_for(path), json: data)
             end
@@ -102,7 +101,7 @@ module Ecoportal
         # @param data [String] the body of the query in json format.
         # @return [Common::Reponse] the basic custom response object.
         def patch(path, data:)
-          instrument("PATCH", path, data) do
+          instrument('PATCH', path, data) do
             request do |http|
               http.patch(url_for(path), json: data)
             end
@@ -113,7 +112,7 @@ module Ecoportal
         # @param path [String] the tail that completes the url of the request.
         # @return [Common::Reponse] the basic custom response object.
         def delete(path)
-          instrument("DELETE", path) do
+          instrument('DELETE', path) do
             request do |http|
               http.delete(url_for(path))
             end
@@ -144,10 +143,10 @@ module Ecoportal
         def base_request
           @base_request ||=
             case @version
-            when "v2"
-              HTTP.headers("X-ECOPORTAL-API-KEY" => @api_key).accept(:json)
+            when 'v2'
+              HTTP.headers('X-ECOPORTAL-API-KEY' => @api_key).accept(:json)
             else
-              HTTP.headers("X-ApiKey" => @api_key).accept(:json)
+              HTTP.headers('X-ApiKey' => @api_key).accept(:json)
             end
         end
 
@@ -161,7 +160,7 @@ module Ecoportal
         private
 
         def instrument(method, path, data = nil, &block)
-          raise "Expected block" unless block_given?
+          raise 'Expected block' unless block_given?
 
           start_time = Time.now.to_f
 
@@ -193,10 +192,10 @@ module Ecoportal
 
         # Logger interface.
         # @example:
-        #   log(:info) {"General information on what's going on"}
-        #   log(:warn) {"This is a warning that something is likely to have gone amiss"}
-        #   log(:error) {"Something went wrong"}
-        #   log(:fatal) {"An unrecoverable error has happend"}
+        #   log(:info) {'General information on what's going on'}
+        #   log(:warn) {'This is a warning that something is likely to have gone amiss'}
+        #   log(:error) {'Something went wrong'}
+        #   log(:fatal) {'An unrecoverable error has happend'}
         # @param level [Symbol] the level that the message should be logged.
         # @yield [] generates the message.
         # @yieldreturn [String] the generated message.

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

@@ -14,12 +14,13 @@ module Ecoportal
 
         def get_id(doc)
           id = nil
-          id ||= doc.id if doc.respond_to?(:id)
-          id ||= doc.external_id if doc.respond_to?(:external_id)
-          id ||= doc["id"] if doc.is_a?(Hash)
-          id ||= doc["external_id"] if doc.is_a?(Hash)
-          id ||= doc if doc.is_a?(String)
-          id or raise "No ID has been given!"
+          id ||= doc.id             if doc.respond_to?(:id)
+          id ||= doc.external_id    if doc.respond_to?(:external_id)
+          id ||= doc['id']          if doc.is_a?(Hash)
+          id ||= doc['external_id'] if doc.is_a?(Hash)
+          id ||= doc                if doc.is_a?(String)
+
+          id or raise 'No ID has been given!'
           id
         end
       end

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

@@ -1,11 +1,11 @@
+# rubocop:disable Naming/MethodParameterName
 module Ecoportal
   module API
     module Common
       module HashDiff
-        ID_KEYS = %w[id]
+        ID_KEYS = %w[id].freeze
 
         class << self
-
           def diff(a, b, ignore: [])
             case a
             when Hash
@@ -14,16 +14,17 @@ module Ecoportal
                   b_value    = b && b[key]
                   no_changes = (a_value == b_value) || ignore.include?(key)
                   next if !ID_KEYS.include?(key) && no_changes
+
                   diffed[key] = diff(a_value, b_value, ignore: ignore)
                   diffed.delete(key) if diffed[key] == {}
                 end
+
                 # All keys are IDs, so it's actually blank
-                if (diffed.keys - ID_KEYS).empty?
-                  return {}
-                end
+                return {} if (diffed.keys - ID_KEYS).empty?
               end
             when Array
               return a unless b.is_a?(Array) && a.length == b.length
+
               a.map.with_index do |a_value, idx|
                 b_value = b[idx]
                 diff(a_value, b_value, ignore: ignore)
@@ -39,3 +40,5 @@ module Ecoportal
     end
   end
 end
+
+# rubocop:enable Naming/MethodParameterName

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

@@ -3,6 +3,7 @@ module Ecoportal
     module Common
       module Logging
         private
+
         def default_logger
           Ecoportal::API::Logger.new
         end

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

@@ -22,7 +22,7 @@ module Ecoportal
 
         def print_pretty
           puts "Status: #{@status.code}"
-          puts "Body:"
+          puts 'Body:'
           puts JSON.pretty_generate(@body)
         end
       end

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

@@ -41,7 +41,7 @@ module Ecoportal
         def print_pretty
           return each(&:print_pretty) if success?
 
-          "Request failed."
+          'Request failed.'
         end
       end
     end

data/lib/ecoportal/api/internal/account.rb

@@ -11,11 +11,11 @@ module Ecoportal
 
         passthrough(*PROPERTIES.map(&:to_sym))
 
-        class_resolver :preferences_class, "Ecoportal::API::Internal::Preferences"
-        class_resolver :permissions_class, "Ecoportal::API::Internal::Permissions"
+        class_resolver :preferences_class, 'Ecoportal::API::Internal::Preferences'
+        class_resolver :permissions_class, 'Ecoportal::API::Internal::Permissions'
 
-        embeds_one  :permissions, key: "permissions_custom", klass: :permissions_class
-        embeds_one  :perms_merged, key: "permissions_merged", klass: :permissions_class
+        embeds_one  :permissions, key: 'permissions_custom', klass: :permissions_class
+        embeds_one  :perms_merged, key: 'permissions_merged', klass: :permissions_class
         embeds_one  :preferences, klass: :preferences_class
 
         # Sets the `default_tag` of the user
@@ -32,60 +32,60 @@ module Ecoportal
             end
             value = value.upcase
           end
-          doc["default_tag"] = value
+          doc['default_tag'] = value
         end
 
         # Sets the `policy_group_ids`
         # @note it preserves the original order
         # @param value [Array<String>] the policy group ids to be set.
         def policy_group_ids=(value)
-          set_uniq_array_keep_order("policy_group_ids", value)
+          set_uniq_array_keep_order('policy_group_ids', value)
         end
 
         # @return [Array<String>] the policy group ids of this user.
         def policy_group_ids
-          doc["policy_group_ids"] ||= []
+          doc['policy_group_ids'] ||= []
         end
 
         # Sets the `login_provider_ids`
         def login_provider_ids=(value)
-          set_uniq_array_keep_order("login_provider_ids", value)
+          set_uniq_array_keep_order('login_provider_ids', value)
         end
 
         # @return [Array<String>] the login provider ids of this user.
         def login_provider_ids
-          doc["login_provider_ids"] ||= []
+          doc['login_provider_ids'] ||= []
         end
 
         # Sets the `starred_ids`
         def starred_ids=(value)
-          set_uniq_array_keep_order("starred_ids", value)
+          set_uniq_array_keep_order('starred_ids', value)
         end
 
         # @return [Array<String>] the starred page ids of this user.
         def starred_ids
-          doc["starred_ids"] ||= []
+          doc['starred_ids'] ||= []
         end
 
         # It preserves the values of keys that are not defined in `value`.
         # @param value [Hash] the abilities that you want to update.
         def permissions_custom=(value)
-          doc["permissions_custom"] ||= {}
-          doc["permissions_custom"].merge!(value)
+          doc['permissions_custom'] ||= {}
+          doc['permissions_custom'].merge!(value)
         end
 
         # It preserves the values of keys that are not defined in `value`.
         # @param value [Hash] the preferences that you want to update.
         def preferences=(value)
-          doc["preferences"] ||= {}
-          doc["preferences"].merge!(value)
+          doc['preferences'] ||= {}
+          doc['preferences'].merge!(value)
         end
 
         def as_json
           super.tap do |hash|
-            hash["permissions_custom"] = permissions.as_json
-            hash["permissions_merged"] = perms_merged.as_json
-            hash["preferences"] = preferences.as_json
+            hash['permissions_custom'] = permissions.as_json
+            hash['permissions_merged'] = perms_merged.as_json
+            hash['preferences'] = preferences.as_json
           end
         end
 

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class Internal
       class People < V1::People
-        class_resolver :person_class,  "Ecoportal::API::Internal::Person"
+        class_resolver :person_class, 'Ecoportal::API::Internal::Person'
       end
     end
   end