ecoportal-api 0.9.8 → 0.10.2

data/ecoportal-api.gemspec

@@ -1,35 +1,44 @@
-
-lib = File.expand_path("../lib", __FILE__)
+# 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"
   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.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 "bundler",   ">= 2.4.12", "< 3"
-  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 'http',          '~> 5.1',   "< 6"
-  spec.add_dependency 'dotenv',        '>= 2.8',   "< 3"
+  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/base_model.rb

@@ -1,11 +1,12 @@
+# rubocop:disable Naming/PredicateName
 module Ecoportal
   module API
     module Common
       class BaseModel
-        class UnlinkedModel < Exception
-          def initialize (msg = "Something went wrong when linking the document.", from: nil, key: nil)
-            msg += " From: #{from}." if from
-            msg += " key: #{key}."   if key
+        class UnlinkedModel < StandardError
+          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)
           end
         end
@@ -25,10 +26,11 @@ module Ecoportal
             end
           end
 
-          def embeds_one(method, key: method, nullable: false, klass:)
+          def embeds_one(method, klass:, key: method, nullable: false)
             method = method.to_s.freeze
             var    = "@#{method}".freeze
             key    = key.to_s.freeze
+
             define_method(method) do
               if instance_variable_defined?(var)
                 value = instance_variable_get(var)
@@ -36,7 +38,9 @@ module Ecoportal
                 return value if (value && doc[key]) || (!value && !doc[key])
                 remove_instance_variable(var)
               end
+
               doc[key] ||= {} unless nullable
+
               return instance_variable_set(var, nil) unless doc[key]
 
               self.class.resolve_class(klass).new(
@@ -44,7 +48,6 @@ module Ecoportal
               ).tap {|obj| instance_variable_set(var, obj)}
             end
           end
-
         end
 
         attr_reader :_parent, :_key
@@ -52,28 +55,32 @@ module Ecoportal
         def initialize(doc = {}, parent: self, key: nil)
           @_parent = parent
           @_key    = key
-          if !_parent || !_key
-            @doc          = JSON.parse(doc.to_json)
-            @original_doc = JSON.parse(@doc.to_json)
-            @initial_doc  = JSON.parse(@doc.to_json)
-          end
+
+          return unless !_parent || !_key
+
+          @doc          = JSON.parse(doc.to_json)
+          @original_doc = JSON.parse(@doc.to_json)
+          @initial_doc  = JSON.parse(@doc.to_json)
         end
 
         def doc
-          raise UnlinkedModel.new(from: "#{self.class}#doc", key: _key)  unless linked?
+          raise UnlinkedModel.new(from: "#{self.class}#doc", key: _key) unless linked?
           return @doc if is_root?
+
           _parent.doc.dig(*[_key].flatten)
         end
 
         def original_doc
-          raise UnlinkedModel.new(from: "#{self.class}#original_doc", key: _key)  unless linked?
+          raise UnlinkedModel.new(from: "#{self.class}#original_doc", key: _key) unless linked?
           return @original_doc if is_root?
+
           _parent.original_doc&.dig(*[_key].flatten)
         end
 
         def initial_doc
-          raise UnlinkedModel.new(from: "#{self.class}#initial_doc", key: _key)  unless linked?
+          raise UnlinkedModel.new(from: "#{self.class}#initial_doc", key: _key) unless linked?
           return @initial_doc if is_root?
+
           _parent.initial_doc&.dig(*[_key].flatten)
         end
 
@@ -81,6 +88,7 @@ module Ecoportal
         # @return [Hash] `doc` before change
         def replace_doc!(new_doc)
           raise UnlinkedModel.new(from: "#{self.class}#replace_doc", key: _key) unless linked?
+
           @doc.tap do
             @doc = new_doc
           end
@@ -90,6 +98,7 @@ module Ecoportal
         # @return [Hash] `original_doc` before change
         def replace_original_doc!(new_doc)
           raise UnlinkedModel.new(from: "#{self.class}#replace_original_doc", key: _key) unless linked?
+
           @original_doc.tap do
             @original_doc = new_doc
           end
@@ -115,7 +124,8 @@ module Ecoportal
 
         # 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?
+          raise UnlinkedModel.new(from: "#{self.class}#consolidate!", key: _key) unless linked?
+
           new_doc = JSON.parse(doc.to_json)
           if is_root?
             @original_doc = new_doc
@@ -130,18 +140,19 @@ module Ecoportal
         #    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)
-          raise "'key' should be a String. Given #{key}" unless !key || key.is_a?(String)
-          raise UnlinkedModel.new(from: "#{self.class}#reset!", key: _key)  unless linked?
+        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?
 
           if key
-            if self.respond_to?(key) && child = self.send(key) && child.is_a?(Ecoportal::API::Common::BaseModel)
+            if respond_to?(key) && (child = send(key)) && child.is_a?(Ecoportal::API::Common::BaseModel)
               child.reset!
             else
               new_doc = original_doc && original_doc[key]
               dig_set(doc, [key], new_doc && JSON.parse(new_doc.to_json))
               # regenerate object if new_doc is null
-              self.send(key) if !new_doc && self.respond_to?(key)
+              send(key) if !new_doc && respond_to?(key)
             end
           else
             new_doc = JSON.parse(original_doc.to_json)
@@ -179,17 +190,17 @@ module Ecoportal
         end
 
         def set_uniq_array_keep_order(key, value)
-          unless value.is_a?(Array)
-            raise "#{key}= needs to be passed an Array, got #{value.class}"
-          end
-          ini_vals = (original_doc && original_doc[key]) || []
+          msg = "#{key}= needs to be passed an Array, got #{value.class}"
+          raise ArgumentError, msg unless value.is_a?(Array)
 
+          ini_vals = (original_doc && original_doc[key]) || []
           value    = value.uniq
           # preserve original order to avoid false updates
           doc[key] = ((ini_vals & value) + (value - ini_vals)).compact
         end
-
       end
     end
   end
 end
+
+# rubocop:enable Naming/PredicateName

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|
@@ -28,19 +32,21 @@ module Ecoportal
           log(:info) { "Processing batch responses" }
 
           body_data(response.body).each.with_index do |subresponse, idx|
-            callback = @operations[idx][:callback]
             status   = subresponse["status"]
-            body     = subresponse["response"]
             method   = @operations[idx][:method]
+            body     = subresponse["response"]
+            callback = @operations[idx][:callback]
 
             if status == 200 && method == "GET"
               batch_response = BatchResponse.new(status, body, @wrapper.new(body))
               log_batch_response(@operations[idx], batch_response)
-              callback && callback.call(batch_response, batch_response.result)
+
+              callback&.call(batch_response, batch_response.result)
             else
               batch_response = BatchResponse.new(status, body)
               log_batch_response(@operations[idx], batch_response)
-              callback && callback.call(batch_response)
+
+              callback&.call(batch_response)
             end
           end
         end
@@ -48,9 +54,9 @@ module Ecoportal
         def get(doc, &block)
           id = get_id(doc)
           @operations << {
-            path:     @base_path + "/" + CGI::escape(id),
+            path:     "#{@base_path}/#{CGI.escape(id)}",
             method:   "GET",
-            callback: block_given? && block
+            callback: block
           }
         end
 
@@ -58,10 +64,10 @@ module Ecoportal
           id   = get_id(doc)
           body = get_body(doc)
           @operations << {
-            path:     @base_path + "/" + CGI::escape(id),
+            path:     "#{@base_path}/#{CGI.escape(id)}",
             method:   "PATCH",
             body:     body,
-            callback: block_given? && block
+            callback: block
           }
         end
 
@@ -69,19 +75,19 @@ module Ecoportal
           id   = get_id(doc)
           body = get_body(doc)
           @operations << {
-            path:     @base_path + "/" + CGI::escape(id),
+            path:     "#{@base_path}/#{CGI.escape(id)}",
             method:   "POST",
             body:     body,
-            callback: block_given? && block
+            callback: block
           }
         end
 
         def delete(doc, &block)
           id = get_id(doc)
           @operations << {
-            path:     @base_path + "/" + CGI::escape(id),
+            path:     "#{@base_path}/#{CGI.escape(id)}",
             method:   "DELETE",
-            callback: block_given? && block
+            callback: block
           }
         end
 
@@ -91,7 +97,7 @@ module Ecoportal
             path:     @base_path,
             method:   "POST",
             body:     body,
-            callback: block_given? && block
+            callback: block
           }
         end
 
@@ -104,14 +110,15 @@ module Ecoportal
         end
 
         def log_batch_response(operation, response)
-          level = response.success?? :debug : :warn
           log(:info) { "BATCH #{operation[:method]} #{operation[:path]}" }
           log(:info) { "Status #{response.status}" }
+
+          level = response.success?? :debug : :warn
           log(level) { "Response: #{JSON.pretty_generate(response.body)}" }
         end
 
         def log(level, &block)
-          @logger.send(level, &block) if @logger
+          @logger&.send(level, &block)
         end
       end
     end

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

@@ -2,7 +2,6 @@ module Ecoportal
   module API
     module Common
       class BatchResponse
-
         attr_reader :status, :body, :result
 
         def initialize(status, body, result = nil)
@@ -15,10 +14,8 @@ module Ecoportal
           status.success?
         end
 
-        def each
-          [*@result].each do |doc|
-            yield doc
-          end
+        def each(&block)
+          [*@result].each(&block)
         end
 
         def print_pretty

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

@@ -3,11 +3,16 @@ module Ecoportal
   module API
     module Common
       # @note
-      #   - You can see the documentation of the `HTTP` module in [the repository](https://github.com/httprb/http)
-      #     - it does `extend` the module `Chainable` ([chainable.rb](https://github.com/httprb/http/blob/master/lib/http/chainable.rb)),
-      #     - where all the http requests are dev by using `HTTP::Client#request` ([client.rb](https://github.com/httprb/http/blob/master/lib/http/client.rb))
-      #     - which calls `build_request` (new `HTTP::Request`) and `perform` (new `HTTP::Connection`)
-      #     - to return `HTTP::Response` ([response.rb](https://github.com/httprb/http/blob/master/lib/http/response.rb))
+      #   - You can see the documentation of the `HTTP` module in
+      #     [the repository](https://github.com/httprb/http)
+      #     - it does `extend` the module `Chainable`
+      #       ([chainable.rb](https://github.com/httprb/http/blob/master/lib/http/chainable.rb)),
+      #     - where all the http requests are dev by using `HTTP::Client#request`
+      #       ([client.rb](https://github.com/httprb/http/blob/master/lib/http/client.rb))
+      #     - which calls `build_request` (new `HTTP::Request`) and `perform`
+      #       (new `HTTP::Connection`)
+      #     - to return `HTTP::Response`
+      #       ([response.rb](https://github.com/httprb/http/blob/master/lib/http/response.rb))
       # @attr_reader logger [Logger] the logger.
       # @attr_reader host [String] the remote target server.
       class Client
@@ -31,15 +36,17 @@ module Ecoportal
           @logger   = logger
           @host     = host
           @response_logging_enabled = response_logging
+
           if host.match(/^localhost|^127\.0\.0\.1/)
             @base_uri = "http://#{host}/api/"
           else
             @base_uri = "https://#{host}/api/"
           end
           log(:info) { "#{version} client initialized pointing at #{host}" }
-          if @api_key.nil? || @api_key.match(/\A\W*\z/)
-            log(:error) { "Api-key missing!" }
-          end
+
+          return unless @api_key.nil? || @api_key.match(/\A\W*\z/)
+
+          log(:error) { "Api-key missing!" }
         end
 
         # Logger interface.
@@ -52,7 +59,7 @@ module Ecoportal
         # @yield [] generates the message.
         # @yieldreturn [String] the generated message.
         def log(level, &block)
-          logger.send(level, &block) if logger
+          logger&.send(level, &block)
         end
 
         # Sends an http `GET` request against the api version using `path` to complete the base url,
@@ -127,18 +134,18 @@ module Ecoportal
           Ecoportal::API::Common::Response.new(response)
         end
 
-        # Creates a HTTP object adding the `X-ApiKey` or `X-ECOPORTAL-API-KEY` param to the header, depending on the API version.
+        # Creates a HTTP object adding the `X-ApiKey` or `X-ECOPORTAL-API-KEY` param
+        # to the header, depending on the API version.
         # @note It configures HTTP so it only allows body data in json format.
         # @return [HTTP] HTTP object.
         def base_request
-          @base_request ||= begin
+          @base_request ||=
             case @version
             when "v2"
               HTTP.headers("X-ECOPORTAL-API-KEY" => @api_key).accept(:json)
             else
               HTTP.headers("X-ApiKey" => @api_key).accept(:json)
             end
-          end
         end
 
         # Full URl builder of the request
@@ -151,19 +158,23 @@ module Ecoportal
         private
 
         def instrument(method, path, data = nil, &block)
-          raise "Expected block" unless block
+          raise "Expected block" unless block_given?
+
           start_time = Time.now.to_f
           log(:info)  { "#{method} #{url_for(path)}" }
           log(:debug) { "Data: #{JSON.pretty_generate(data)}" }
 
           with_retry(&block).tap do |result|
             end_time = Time.now.to_f
-            log(result.success?? :info : :warn) do
-              "Took %.2fs, Status #{result.status}" % (end_time - start_time)
-            end
-            log(result.success?? :debug : :warn) do
+            log(result.success?? :info : :warn) {
+              "Took %.2fs, Status #{result.status}" % (end_time - start_time) # rubocop:disable Style/FormatString
+            }
+
+            next unless @response_logging_enabled
+
+            log(result.success?? :debug : :warn) {
               "Response: #{JSON.pretty_generate(result.body)}"
-            end if @response_logging_enabled
+            }
           end
         end
 
@@ -190,9 +201,11 @@ module Ecoportal
             puts "re-attempting (remaining: #{remaining} attempts out of #{attempts})"
 
             log_unexpected_server_error(response)
+
             msg  = "Got server error (#{response.status}): #{response.body}\n"
             msg += "Going to retry (#{i} out of #{attempts})"
             log(:error) { msg }
+
             sleep(delay) if i < attempts
           end
           response

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/response.rb

@@ -13,7 +13,7 @@ module Ecoportal
             end
           end.join.to_s
 
-          @body = JSON.parse(@src_body) rescue nil
+          @body = JSON.parse(@src_body) rescue nil # rubocop:disable Style/RescueModifier
         end
 
         def success?

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/wrapped_response.rb

@@ -10,26 +10,24 @@ module Ecoportal
           @response = response
           @klass    = klass
 
-          if @response.success?
-            @result =
-              if @response.body.is_a?(Array)
-                @response.body.map do |doc|
-                  @klass.new(doc)
-                end
-              else
-                @klass.new(@response.body)
+          return unless @response.success?
+
+          @result =
+            if @response.body.is_a?(Array)
+              @response.body.map do |doc|
+                @klass.new(doc)
               end
-          end
+            else
+              @klass.new(@response.body)
+            end
         end
 
         def body
           response.body.to_s
         end
 
-        def each
-          [*result].each do |doc|
-            yield doc
-          end
+        def each(&block)
+          [*result].each(&block)
         end
 
         def status
@@ -41,13 +39,10 @@ module Ecoportal
         end
 
         def print_pretty
-          if success?
-            each(&:print_pretty)
-          else
-            puts "Request failed."
-          end
-        end
+          return each(&:print_pretty) if success?
 
+          "Request failed."
+        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/internal/account.rb

@@ -2,13 +2,14 @@ module Ecoportal
   module API
     class Internal
       class Account < Common::BaseModel
-        PROPERTIES = [
-          "user_id", "policy_group_ids", "default_tag", "prefilter",
-          "permissions_custom", "permissions_merged", "preferences",
-          "login_provider_ids", "starred_ids", "landing_page_id",
-          "accept_eula", "send_invites", "force_send_invites"
-        ]
-        passthrough *PROPERTIES.map(&:to_sym)
+        PROPERTIES = %w[
+          user_id policy_group_ids default_tag prefilter
+          permissions_custom permissions_merged preferences
+          login_provider_ids starred_ids landing_page_id
+          accept_eula send_invites force_send_invites
+        ].freeze
+
+        passthrough(*PROPERTIES.map(&:to_sym))
 
         class_resolver :preferences_class, "Ecoportal::API::Internal::Preferences"
         class_resolver :permissions_class, "Ecoportal::API::Internal::Permissions"
@@ -23,11 +24,11 @@ module Ecoportal
         # @return [String, nil] the value set in `default_tag`
         def default_tag=(value)
           unless !value || value.is_a?(String)
-            raise ArgumentError.new("default_tag= needs to be passed a String or nil, got #{value.class}")
+            raise ArgumentError, "default_tag= needs to be passed a String or nil, got #{value.class}"
           end
           if value
             unless value.match(Ecoportal::API::V1::Person::VALID_TAG_REGEX)
-              raise ArgumentError.new("Invalid default tag #{value.inspect}")
+              raise ArgumentError, "Invalid default tag #{value.inspect}"
             end
             value = value.upcase
           end
@@ -89,7 +90,7 @@ module Ecoportal
         end
 
         def as_update(ref = :last, ignore: [])
-          super(ref, ignore: ignore | ["user_id", "permissions_merged", "prefilter"])
+          super(ref, ignore: ignore | %w[user_id permissions_merged prefilter])
         end
       end
     end

data/lib/ecoportal/api/internal.rb

@@ -3,12 +3,12 @@ module Ecoportal
     class Internal < V1
       include Common::Logging
 
-      VERSION = "v0"
-      class_resolver :people_class,  "Ecoportal::API::Internal::People"
-      class_resolver :person_schemas_class,  "Ecoportal::API::Internal::PersonSchemas"
+      VERSION = "v0".freeze
+      class_resolver :people_class, "Ecoportal::API::Internal::People"
+      class_resolver :person_schemas_class, "Ecoportal::API::Internal::PersonSchemas"
 
-      class_resolver :policy_groups_class,  "Ecoportal::API::Internal::PolicyGroups"
-      class_resolver :login_providers_class,  "Ecoportal::API::Internal::LoginProviders"
+      class_resolver :policy_groups_class, "Ecoportal::API::Internal::PolicyGroups"
+      class_resolver :login_providers_class, "Ecoportal::API::Internal::LoginProviders"
 
       # Obtain specific object for policy groups api requests.
       # @return [PolicyGroups] an instance object ready to make policy groups api requests.