ecoportal-api-v2 1.1.8 → 2.0.0

data/ecoportal-api-v2.gemspec

@@ -1,5 +1,4 @@
-
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "ecoportal/api/v2_version"
 
@@ -9,25 +8,27 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Oscar Segura"]
   spec.email         = ["rien@ecoportal.co.nz", "oscar@ecoportal.co.nz", "bozydar@ecoportal.co.nz"]
 
-  spec.summary       = %q{A collection of helpers for interacting with the ecoPortal MS's V2 API}
+  spec.summary       = "A collection of helpers for interacting with the ecoPortal MS's V2 API"
   spec.homepage      = "https://www.ecoportal.com"
   spec.licenses      = %w[MIT]
 
-  spec.required_ruby_version = '>= 2.7.2'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.required_ruby_version = '>= 3.2.2'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler",   ">= 2.4.12", "< 3"
-  spec.add_development_dependency "rspec",     ">= 3.12.0", "< 4"
-  spec.add_development_dependency "rake",      ">= 13.0.3", "< 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 "yard",      '~>  0.9.34'
 
-  spec.add_dependency 'ecoportal-api', '>= 0.9.6', '< 0.10'
+  spec.add_dependency 'ecoportal-api', '~> 0.10'
+  spec.add_dependency 'mime-types',    '~> 3.5', '>= 3.5.2'
 end

data/lib/ecoportal/api/common/concerns/benchmarkable.rb

@@ -14,59 +14,63 @@ module Ecoportal
             @benchmark_enabled
           end
 
-          def benchmarking(ref = nil, print: false)
+          def benchmarking(ref = nil, units: 1, print: false, &block)
             return yield unless benchmark_enabled?
-            benchmark_mem(ref, print: false) do
-              benchmark_time(ref, print: false) do
-                yield
-              end
+            benchmark_mem(ref, units: units, print: false) do
+              benchmark_time(ref, units: units, print: false, &block)
             end.tap do
               puts "\n#{bench_summary_ref(ref)}" if print
             end
           end
 
-          def benchmark_mem(ref = nil, print: false)
+          def benchmark_mem(ref = nil, units: 1, print: false)
             return yield unless benchmark_enabled?
+
             memory_before = memory_usage
             yield.tap do
               memory_after = memory_usage
               mb_footprint = ((memory_after - memory_before) / 1024.0).round(2)
-              bench_add_mem(ref, mb_footprint)
+              bench_add_mem(ref, mb_footprint, units: units)
               puts bench_str_mem(mb, ref: ref, reffix: true) if print
             end
           end
 
-          def benchmark_time(ref = nil, print: false)
+          def benchmark_time(ref = nil, units: 1, print: false)
             return yield unless benchmark_enabled?
+
             result = nil
             time   = benchmark.realtime do
               result = yield
             end.round(2)
+
             result.tap do
-              bench_add_time(ref, time)
+              bench_add_time(ref, time, units: units)
               puts bench_str_time(time, ref: ref, reffix: true) if print
             end
           end
 
           def benchmark_summary(ref = nil)
-            return '' unless benchmark_enabled?
+            return ''                     unless benchmark_enabled?
             return bench_summary_ref(ref) unless ref == :all
 
-            bench.keys.each_with_object([]) do |ref, out|
-              out << bench_summary_ref(ref)
+            bench.keys.each_with_object([]) do |rf, out|
+              out << bench_summary_ref(rf)
             end.join("\n")
           end
 
           def bench_summary_ref(ref = nil)
             ref_lines = bench_summary_ref_lines(ref)
-            "- #{ref}\n" + "  • " + ref_lines.join("\n  • ")
+            msg =  "- #{ref}\n"
+            msg << "  • "
+            msg << ref_lines.join("\n  • ")
+            msg
           end
 
           def bench_summary_ref_lines(ref = nil)
             ref_bench = bench_get(ref)
             [
-              bench_str_time(*ref_bench[:time].values_at(:avg, :cnt), ref: ref),
-              bench_str_mem(*ref_bench[:mem].values_at(:avg, :cnt), ref: ref)
+              bench_str_time(*ref_bench[:time].values_at(:avg, :cnt, :last), ref: ref),
+              bench_str_mem(*ref_bench[:mem].values_at(:avg, :cnt, :last), ref: ref)
             ]
           end
 
@@ -79,12 +83,12 @@ module Ecoportal
             @bench ||= {}
           end
 
-          def bench_add_mem(ref, mem)
-            bench_data_push(bench_get(ref)[:mem], mem)
+          def bench_add_mem(ref, mem, units: 1)
+            bench_data_push(bench_get(ref)[:mem], mem, units: units)
           end
 
-          def bench_add_time(ref, time)
-            bench_data_push(bench_get(ref)[:time], time)
+          def bench_add_time(ref, time, units: 1)
+            bench_data_push(bench_get(ref)[:time], time, units: units)
           end
 
           def bench_get(ref)
@@ -96,50 +100,58 @@ module Ecoportal
 
           def bench_data
             {
-              avg: nil,
-              cnt: 0
+              avg:  nil,
+              cnt:  0,
+              last: nil
             }
           end
 
-          def bench_data_push(data, value)
-            total       = value + ( (data[:avg] || 0) * data[:cnt])
-            data[:cnt] += 1
+          def bench_data_push(data, value, units: 1)
+            total       = value + ((data[:avg] || 0) * data[:cnt])
+            data[:last] = value.round(3)
+            data[:cnt] += units
             data[:avg]  = (total / data[:cnt]).round(3)
             data
           end
 
-          def bench_str_mem(mem, count = nil, ref: nil, reffix: false)
-            ref = reffix ? ref : nil
+          def bench_str_mem(mem, count = nil, last = nil, ref: nil, reffix: false)
+            ref = nil unless reffix
             msg = [ref, 'Memory'].compact.join(' -- ')
-            cnt = count ? " (cnt: #{count})" : ''
+            cnt = count ? " (cnt: #{count}; lst: #{last} MB)" : ''
             "#{msg}: #{mem} MB#{cnt}"
           end
 
           def active_support_duration?
             return false unless Kernel.const_defined?(:ActiveSupport)
+
             ActiveSupport.const_defined?(:Duration, false)
           end
 
-          def bench_str_time(time, count = nil, ref: nil, reffix: false)
-            ref      = reffix ? ref : nil
+          def bench_str_time(time, count = nil, last = nil, ref: nil, reffix: false)
+            ref      = nil unless reffix
             msg      = [ref, 'Time'].compact.join(' -- ')
             total    = (time * count).round(2)
             str_desc = ''
+
             if active_support_duration? && total >= 60
               duration = ActiveSupport::Duration.build(total.round)
-              str_desc = ": #{duration_to_s(duration)}"
+              str_desc = " > #{duration_to_s(duration)}"
             end
-            cnt      = count ? " (cnt: #{count}; sum: #{total} s#{str_desc})" : ''
+
+            cnt      = count ? " (cnt: #{count}; lst: #{last} s ; sum: #{total} s#{str_desc})" : ''
             "#{msg}: #{time} s#{cnt}"
           end
 
           def duration_to_s(value)
-            return "" unless active_support_duration?
-            return "" if value.nil?
+            return '' unless active_support_duration?
+            return '' if value.nil?
+
+            msg = "Expecint ActiveSupport::Duration. Given: #{value.class}"
+            raise ArgumentError, msg unless value.is_a?(ActiveSupport::Duration)
 
-            raise ArgumentError, "Expecint ActiveSupport::Duration. Given: #{value.class}" unless value.is_a?(ActiveSupport::Duration)
             parts = value.parts.map {|pair| pair.reverse.join(" ")}
             return parts.first if parts.length == 1
+
             [parts[..-2].join(", "), parts.last].join(" and ")
           end
 
@@ -148,6 +160,7 @@ module Ecoportal
             if Gem.win_platform?
               wmem = `wmic process where processid=#{Process.pid} get WorkingSetSize | findstr "[0-9]"`
               return 0 unless wmem
+
               wmem.lines.first.chop.strip.to_i / 1024.0
             else
               `ps -o rss= -p #{Process.pid}`.to_i

data/lib/ecoportal/api/common/concerns/threadable.rb

@@ -0,0 +1,41 @@
+module Ecoportal
+  module API
+    module Common
+      module Concerns
+        module Threadable
+          private
+
+          def new_thread(threads, max: 20, &block)
+            if max == 1
+              yield
+              return []
+            end
+
+            threads.shift.join if threads.count >= max
+            threads << Thread.new(&block)
+          end
+
+          def mutex(key = :general)
+            require 'thread'
+            key           = key.to_sym
+            @mutex      ||= {}
+            @mutex[key] ||= Mutex.new
+          end
+
+          def with_preserved_thread_globals(abort: false, report: true)
+            mutex(:thread_globals).synchronize do
+              aux_thr_aoe = Thread.abort_on_exception
+              aux_thr_roe = Thread.report_on_exception
+              Thread.abort_on_exception  = abort
+              Thread.report_on_exception = report
+              yield
+            ensure
+              Thread.abort_on_exception  = aux_thr_aoe
+              Thread.report_on_exception = aux_thr_roe
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -7,4 +7,5 @@ module Ecoportal
   end
 end
 
+require 'ecoportal/api/common/concerns/threadable'
 require 'ecoportal/api/common/concerns/benchmarkable'

data/lib/ecoportal/api/common/content/array_model.rb

@@ -8,8 +8,8 @@ module Ecoportal
         class ArrayModel < Content::DoubleModel
           class TypeMismatchedComparison < StandardError
             def initialize(this: nil, that: msg = "Trying to compare objects with different behavior.")
-              msg += " From object with 'order_matters: #{this.order_matters?}' and 'uniq: #{this.uniq?}'." if this
-              msg += " To object where 'order_matters: #{that.order_matters?}' and 'uniq: #{that.uniq?}'."  if that
+              msg << " From object with 'order_matters: #{this.order_matters?}' and 'uniq: #{this.uniq?}'." if this
+              msg << " To object where 'order_matters: #{that.order_matters?}' and 'uniq: #{that.uniq?}'."  if that
               super(msg)
             end
           end
@@ -22,7 +22,7 @@ module Ecoportal
             # @param a [ArrayModel]
             # @param b [ArrayModel]
             # @return [Boolean] `true` if both elements have same behaviour
-            def same_type?(a, b)
+            def same_type?(a, b) # rubocop:disable Naming/MethodParameterName
               msg = "To use this comparison both objects should be `ArrayModel`"
               raise msg unless a.is_a?(ArrayModel) && b.is_a?(ArrayModel)
               (a.order_matters? == b.order_matters?) && (a.uniq? == b.uniq?)
@@ -57,6 +57,7 @@ module Ecoportal
 
           def each(&block)
             return to_enum(:each) unless block
+
             _items.each(&block)
           end
 
@@ -273,12 +274,14 @@ module Ecoportal
           def into_a(value)
             raise "Can't convert to 'Array' a 'Hash', as is a key_value pair Enumerable" if value.is_a?(Hash)
             return value.to_a.slice(0..-1) if value.is_a?(Enumerable)
+
             [].push(value).compact
           end
 
           def deletion!(value)
             return _items.delete(value) if uniq?
             return                      unless (idx = _items.index(value))
+
             _items.slice!(idx)
           end
         end

data/lib/ecoportal/api/common/content/class_helpers.rb

@@ -41,7 +41,7 @@ module Ecoportal
           # @param key [String, Symbol] to be normalized
           # @return [String] a correct constant name
           def to_constant(key)
-            key.to_s.strip.split(/::/).compact.map do |str|
+            key.to_s.strip.split('::').compact.map do |str|
               str.slice(0).upcase + str.slice(1..-1)
             end.join.split(/[\-\_ :]+/i).compact.map do |str|
               str.slice(0).upcase + str.slice(1..-1)
@@ -67,15 +67,17 @@ module Ecoportal
           # If the class for `name` exists, it returns it. Otherwise it generates it.
           # @param name [String, Symbol] the name of the new class
           # @param inherits [Class] the parent class to _inherit_ from
-          # @param namespace [Class, String] an existing `constant` (class or module) the new class will be namespaced on
+          # @param namespace [Class, String] an existing `constant` (class or module)
+          #   the new class will be namespaced on
           # @yield [child_class] configure the new class
           # @yieldparam child_class [Class] the new class
           # @return [Class] the new generated class
           def new_class(name = "Child#{uid}", inherits: self, namespace: inherits)
-            name       = name.to_s.to_sym.freeze
-            class_name = to_constant(name)
+            name         = name.to_s.to_sym.freeze
+            class_name   = to_constant(name)
+            target_class = resolve_class("#{namespace}::#{class_name}", exception: false)
 
-            unless target_class = resolve_class("#{namespace}::#{class_name}", exception: false)
+            unless target_class
               target_class = Class.new(inherits)
               Kernel.const_get(namespace.to_s).const_set class_name, target_class
             end
@@ -131,9 +133,11 @@ module Ecoportal
           # Builds the attr_reader and attr_writer of `attrs` and registers the associated instance variable as inheritable.
           def inheritable_attrs(*attrs)
             attrs.each do |attr|
-              class_eval %(
-                class << self; attr_accessor :#{attr} end
-              )
+              class_eval <<-DEF_CLSS_ATTR, __FILE__, __LINE__ + 1
+                class << self            # class << self
+                  attr_accessor :#{attr} #   attr_accessor :coolio
+                end                      # end
+              DEF_CLSS_ATTR
             end
             inheritable_class_vars(*attrs)
           end

data/lib/ecoportal/api/common/content/collection_model.rb

@@ -142,7 +142,7 @@ module Ecoportal
                 #print "{{#{p}}}"
               end
             else
-              show_str = \
+              show_str =
                 case value
                 when Hash
                   value.pretty_inspect
@@ -329,20 +329,20 @@ module Ecoportal
           end
 
           def _doc_upsert(value, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
-            current_pos =
-              if (elem = self[value])
-                _doc_key(elem)
-              end
+            elem        = self[value]
+            current_pos = nil
+            current_pos = _doc_key(elem) if elem
 
             pos   = scope_position(pos: pos, before: before, after: after)
             pos ||= current_pos
 
             if current_pos && pos
               _doc_items.delete_at(current_pos)
-              pos = pos <= current_pos ? pos : pos - 1
+              pos -= 1 unless pos <= current_pos
             end
 
-            pos = (pos && pos < _doc_items.length)? pos : _doc_items.length # rubocop:disable Style/TernaryParentheses
+            pos = _doc_items.length unless pos && pos < _doc_items.length
+
             pos.tap do |_i|
               _doc_items.insert(pos, value)
             end

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

@@ -7,25 +7,26 @@ module Ecoportal
 
           attr_reader :response, :result
 
-          def initialize(response, klass, key: nil)
+          def initialize(response, klass, key: nil) # rubocop:disable Lint/MissingSuper
             @response = response
             @klass    = klass
             @key      = key
 
-            if @response.success?
-              @result =
-                if data.is_a?(Array)
-                  data.map do |doc|
-                    @klass.new(doc)
-                  end
-                else
-                  @klass.new(data)
+            return unless @response.success?
+
+            @result =
+              if data.is_a?(Array)
+                data.map do |doc|
+                  @klass.new(doc)
                 end
-            end
+              else
+                @klass.new(data)
+              end
           end
 
           def data
             return @data if instance_variable_defined?(:@data)
+
             @data = (response.body || {})["data"]
             @data = @data[@key] if @key && @data
             @data
@@ -34,7 +35,6 @@ module Ecoportal
           def body
             data.to_s
           end
-
         end
       end
     end

data/lib/ecoportal/api/v2/page/component/reference_field.rb

@@ -25,8 +25,8 @@ module Ecoportal
                 ref_ids.each do |ref_id|
                   next if reference_ids.include?(ref_id)
                   refs.push({
-                    "id" => ref_id,
-                    "weight" => 0,
+                    "id"        => ref_id,
+                    "weight"    => 0,
                     "patch_ver" => 0
                   })
                 end
@@ -39,9 +39,13 @@ module Ecoportal
 
             def delete(*ref_ids)
               ref_ids.each do |ref_id|
-                if doc_ref = doc["references"].find {|doc_ref| doc_ref["id"] == ref_id}
-                  doc["references"].delete(doc_ref)
+                doc_ref = doc["references"].find do |df|
+                  df["id"] == ref_id
                 end
+
+                next unless doc_ref
+
+                doc["references"].delete(doc_ref)
               end
             end
 
@@ -62,21 +66,21 @@ module Ecoportal
                   self.display_fields = true
                   self.display_fields_in_lookup = true
                 when Hash
-                  supported = [:create, :attach, :metadata]
-                  unless (rest = hash_except(cnf.dup, *supported)).empty?
-                    unused.push(rest)
-                  end
-                  if cnf.key?(:create)   then self.hide_create = !cnf[:create] end
-                  if cnf.key?(:attach)   then self.hide_attach = !cnf[:attach] end
-                  if cnf.key?(:metadata) then self.hide_metadata = !cnf[:metadata] end
+                  supported = %i[create attach metadata]
+                  rest      = hash_except(cnf.dup, *supported)
+
+                  unused.push(rest) unless rest.empty?
+
+                  self.hide_create   = !cnf[:create]   if cnf.key?(:create)
+                  self.hide_attach   = !cnf[:attach]   if cnf.key?(:attach)
+                  self.hide_metadata = !cnf[:metadata] if cnf.key?(:metadata)
                 else
                   unused.push(cnf)
                 end
-              end.yield_self do |unused|
+              end.then do |unused|
                 super(*unused)
               end
             end
-
           end
         end
       end

data/lib/ecoportal/api/v2/page/component.rb

@@ -14,7 +14,7 @@ module Ecoportal
           class_resolver :plain_text_field_class, "Ecoportal::API::V2::Page::Component::PlainTextField"
           class_resolver :rich_text_field_class,  "Ecoportal::API::V2::Page::Component::RichTextField"
           class_resolver :people_field_class,     "Ecoportal::API::V2::Page::Component::PeopleField"
-          class_resolver :contractor_entities_field_class, "Ecoportal::API::V2::Page::Component::ContractorEntitiesField"
+          class_resolver :contractor_entities_field_class, "Ecoportal::API::V2::Page::Component::ContractorEntitiesField" # rubocop:disable Layout/LineLength
           class_resolver :checklist_field_class,  "Ecoportal::API::V2::Page::Component::ChecklistField"
           class_resolver :action_field_class,     "Ecoportal::API::V2::Page::Component::ActionField"
           class_resolver :actions_field_class,    "Ecoportal::API::V2::Page::Component::ActionsField"
@@ -112,6 +112,7 @@ module Ecoportal
           def ref(any_length: false)
             digest = self.class.hash_label(label, any_length: any_length)
             return unless digest
+
             [type, digest].join(".")
           end
 
@@ -165,7 +166,7 @@ module Ecoportal
           # @note careful with this, depending what's done in the force, this may brake the force.
           def replace(fld)
             if fld.section
-              fld.move(section: self.section, before: self)
+              fld.move(section: section, before: self)
             else
               section.add(fld, before: self)
             end
@@ -178,7 +179,7 @@ module Ecoportal
           end
 
           def delete!
-            bindings.each {|b| b.delete!}
+            bindings.each(&:delete!)
             unattach!
             _parent.delete!(self)
           end
@@ -216,7 +217,9 @@ module Ecoportal
                 unused.push(cnf)
               end
             end.tap do |unused|
-              raise "Unsupported configuration options '#{unused}' for #{self.class}" unless unused.empty?
+              next if unused.empty?
+
+              raise "Unsupported configuration options '#{unused}' for #{self.class}"
             end
           end
         end

data/lib/ecoportal/api/v2/page/force.rb

@@ -43,7 +43,7 @@ module Ecoportal
 
           # It sets the `script` value by using `custom_script` and `helpers[N..1].script`
           def update_script
-            doc["script"] = helpers.to_a.reverse.map(&:script).push(self.custom_script).join("\n")
+            doc["script"] = helpers.to_a.reverse.map(&:script).push(custom_script).join("\n")
           end
         end
       end

data/lib/ecoportal/api/v2/page/stages.rb

@@ -5,27 +5,26 @@ module Ecoportal
         class Stages < Common::Content::CollectionModel
           class_resolver :stage_class, "Ecoportal::API::V2::Page::Stage"
 
-          self.klass = :stage_class
+          self.klass     = :stage_class
           self.order_key = :ordering
-          
+
           def ooze
-            self._parent.ooze
+            _parent.ooze
           end
 
           # @param name [String, Regexp] the `name` of the stage to find.
           # @return [Ecoportal::API::V2::Page::Stage, nil]
           def get_by_name(name)
-            self.find do |stage|
+            find do |stage|
               same_string?(stage.name, name)
             end
           end
 
           def ordered
-            self.sort_by.with_index do |stage, index|
+            sort_by.with_index do |stage, index|
               [stage.ordering, index]
             end
           end
-
         end
       end
     end