ecoportal-api 0.7.4 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 275ffcb5e9bfe17f44295a7c4438b9e169dc87f22afe19591752425ef008cdba
-  data.tar.gz: aeb53e930f75dc7299fc400a8a00624428dfe496b77a5fdf1af1075b144a6944
+  metadata.gz: dc651f2474f74b8f767c9df5b4611bd8adefdff75f8e25365135c89561229738
+  data.tar.gz: cb7a8ff5c0c03ba7e371f987d6b277c001b33e57716ab6cf03628d28bac53b61
 SHA512:
-  metadata.gz: 2e2e4c03089ccf675057b335a9c9e46a5a40a92d3720b256fb9a679eec6431885889171960bf106e3586efbc77d9b2384262c9e4aa52cdf34b6c291be78b76dd
-  data.tar.gz: c1df25f369172d215ba64bf932b63d78514871579540edabc991719a737999a5700828352bceca140d5715861b47cb6b2e4e56fab4b7b916fe5ef42627ec7e4f
+  metadata.gz: f89285565edeaa9cbe4a98970bae8602a943c7c865121a89782f512353a8be74529578eecb4f48e893f546f172425dd38af0759412f53b8fc3a91989d6dbe52a
+  data.tar.gz: 4f51e3e6d080745261c033acf511fdd341ebf9f97003f4dda5067c49c9ef51adf966c51cf268e4991e741b45c803fc6c1e821051832c090ba2c685f03c4eaa7d

data/CHANGELOG.md

@@ -1,6 +1,101 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [0.8.4] - 2021-10-xx
+
+### Added
+  - `Ecoportal::API::Internal::Permissions` added abilities
+    - `visitor_management`, `cross_register_reporting` and `broadcast_notifications`
+  - Some yardocs too
+    - Some callbacks are done in a non-obvious way and the returned object type was not documented
+    - For this reason, some yardocs have been added to some of the parts that have been worked on.
+
+### Fixed
+  - `Ecoportal::API::V1::People#create_job`
+    - **Removed** call to `BatchOperation#process_response`
+      - The method was is already called by `job_result`
+      - As a consequence there was a double up of `callbacks`
+    - **Fixed** line in wrong position
+  - `Ecoportal::API::V1::People#batch`
+  - `Ecoportal::API::Common::ElasticApmIntegration#unexpected_server_error?`
+    - No code or code lesser than 100 is a server error as well
+
+### Changed
+  - `Ecoportal::API::Common::Client`: changed
+    - Logging the **response** of batches or batch jobs can be handy when debugging the back-end
+    - **removed** method `#without_response_logging`
+      - This change entailed to remove dependencies in `Ecoportal::API::V1::People`
+        - Specifically in methods `#batch`, `#job_result` and `#create_job`
+    - `@response_logging_enabled` to be set in initialization stage (added parameter for `.new`)
+
+## [0.8.3] - 2021-05-24
+
+### Added
+  - `Ecoportal::API::Errors` namespace
+    - `Ecoportal::API::Errors::Base` base error class.
+    - `Ecoportal::API::Errors::TimeOut` error when an api request fails with time out.
+      - This serves the purpose to allow a client script to re-start the process where it stopped by capturing this specific Error
+  - `Ecoportal::API::Common::BaseModel::UnlinkedModel` added more description to track down the source of the error.
+  - `Ecoportal::API::Common::BaseModel#reset!` added parameter `key`, which should try to recover `doc[key]` from `original_doc[key]`
+    - Thanks to this, you are supposed to be able to do things like:
+      - `person.account = nil && person.reset!("account")`
+      - `person.name    = nil && person.reset!("name")`
+  - `Ecoportal::API::V1::People#job` methods to provide more information on failure.
+  - Specific changes due to eP **release `1.5.9.70`** (_Policy Group Abilities_)
+    - `Ecoportal::API::Internal::Account#permissions_merged`
+    - `Ecoportal::API::Internal::Permissions#person_abilities` (new ability)
+    - `Ecoportal::API::Internal::Account#user_id`
+
+### Fixed
+  - `Ecoportal::API::Internal::Account`: consistency in setting arrays (`uniq!` & `compact`)
+    - `#policy_group_ids=`, `#login_provider_ids=`, `#starred_ids=`
+  - `Ecoportal::API::Common::HashDiff.diff` was including empty `{}` objects
+    - This change sacrifices the case `account: {}` (which will be also removed from `as_update`), but it should be fine.
+
+### Changed
+  - `Ecoportal::API::V1::People#job` to raise specific error on time out `API::Errors::TimeOut`
+  - Specific changes due to eP **release `1.5.9.70`** (_Policy Group Abilities_)
+    - `Ecoportal::API::Internal::Account` **removed** methods: `#permissions_preset`, `#preset` and `#preset=`
+    - `Ecoportal::API::Internal::Person#account=` added support for `user_id` which should remain unchanged when existing
+  - **remove** from `as_update` **read-only** data
+    - `Ecoportal::API::Common::HashDiff.diff` added parameter `:ignore` (`Array`)
+    - `Ecoportal::API::Common::BaseModel#as_update` added parameter `:ignore`
+    - `Ecoportal::API::V1::Person#as_update` added method, which ignores `subordinates`
+    - `Ecoportal::API::Internal::Person#as_update` added method, which ignores `user_id`, `permissions_merged` and `prefilter`
+    - `Ecoportal::API::Internal::Account#as_update` added method, which ignores `user_id`, `permissions_merged` and `prefilter`
+    - `Ecoportal::API::Common::Client` native support for `elastic-apm`
+      - Via new module `Ecoportal::API::Common::ElasticApmIntegration` with method `log_unexpected_server_error`, which will only log an `UnexpectedServerError` to _ElasticAPM_ if
+        1. There's a correct configuration: environmental variables `ELASTIC_APM_KEY` and `ELASTIC_APM_ACCOUNT_ID` are defined
+        2. The `Response` from the server gave `code` in the range `5xx` (which are those under server responsibility)
+    - `Ecoportal::API::Common::Client` added retry logics when `response.status == 5xx`
+
+## [0.8.2] - 2021-02-24
+
+### Added
+
+### Fixed
+  - `Ecoportal::API::V1::Person#filter_tags=` should ignore `nil` values
+
+### Changed
+  - removed all the namespace under `Ecoportal::API::V2` as that is managed by `ecoportal-api-oozes` gem
+    - url: https://rubygems.org/gems/ecoportal-api-oozes
+  - `Ecoportal::API::V1::People.get` should return a `Person` object
+    - observe that it was returning the `WrappedResponse` (an `Enumerable` helper that works better when getting multiple people).
+
+## [0.7.5] - 2021-02-12
+
+### Added
+
+### Fixed
+  - `pretty_print` method was colliding with `pp` module:
+    - renamed to `Ecoportal::API::Common::BaseModel#print_pretty`
+    - renamed to `Ecoportal::API::Common::BatchReponse#print_pretty`
+    - renamed to `Ecoportal::API::Common::Reponse#print_pretty`
+    - renamed to `Ecoportal::API::Common::WrappedResponse#print_pretty`
+
+### Changed
+  - forgot to change `Ecoportal::API::VERSION` during last release
+
 ## [0.7.4] - 2021-01-2
 
 ### Added
@@ -62,6 +157,10 @@ All notable changes to this project will be documented in this file.
 ## [0.7.0] - 2020-09-11
 
 ### Added
+  - added hook, **private** method `body_data` for child classes to define behaviour on `response.body` to
+    - `Ecoportal::API::V1::People`
+    - `Ecoportal::API::Common::BatchOperation`
+
 ### Changed
   - `Ecoportal::API::Internal::Permissions`: **update for new abilities of ecoPortal release `1.5.2`**
     - decoupled abilities: `person_core` into `person_core_create`, `person_core_edit`

data/ecoportal-api.gemspec

@@ -13,6 +13,8 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://www.ecoportal.com"
   spec.licenses      = %w[MIT]
 
+  spec.required_ruby_version = '>= 2.4.4'
+
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
@@ -20,13 +22,15 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler",   "~> 2.1", ">= 2.1.3"
-  spec.add_development_dependency "rake",      "~> 12.0"
-  spec.add_development_dependency "rspec",     "~> 3",   ">= 3.9"
-  spec.add_development_dependency "yard",      "~> 0.9", ">= 0.9.18"
-  spec.add_development_dependency "redcarpet", "~> 3.5", ">= 3.5.0"
-  spec.add_development_dependency "pry"      , "~> 0.13"
+  spec.add_development_dependency "bundler",   ">= 2.2.17",  "< 2.3"
+  spec.add_development_dependency "rspec",     ">= 3.10.0", "< 3.11"
+  spec.add_development_dependency "rake",      ">= 13.0.3", "< 13.1"
+  spec.add_development_dependency "yard",      ">= 0.9.26", "< 0.10"
+  spec.add_development_dependency "redcarpet", ">= 3.5.1",  "< 3.6"
+  spec.add_development_dependency "pry"      , "~> 0.14"
 
-  spec.add_dependency 'http',          '~> 4'
+  spec.add_dependency 'http',          '~> 4.4.1', "< 5"
+  spec.add_dependency 'dotenv',        '>= 2.7.6', "< 2.8"
+  spec.add_dependency 'elastic-apm',   '>= 4.0.0', "< 4.1"
   spec.add_dependency 'hash-polyfill', '~> 0'
 end

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

@@ -3,7 +3,9 @@ module Ecoportal
     module Common
       class BaseModel
         class UnlinkedModel < Exception
-          def initialize (msg = "Something went wrong when linking the document.")
+          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
@@ -28,7 +30,12 @@ module Ecoportal
             var    = "@#{method}".freeze
             key    = key.to_s.freeze
             define_method(method) do
-              return instance_variable_get(var) if instance_variable_defined?(var)
+              if instance_variable_defined?(var)
+                value = instance_variable_get(var)
+                return value unless nullable
+                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]
 
@@ -53,19 +60,19 @@ module Ecoportal
         end
 
         def doc
-          raise UnlinkedModel.new  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  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  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
@@ -78,18 +85,19 @@ module Ecoportal
           doc.to_json(*args)
         end
 
-        def as_update(ref = :last)
+        def as_update(ref = :last, ignore: [])
           new_doc = as_json
           ref_doc = ref == :total ? initial_doc : original_doc
-          Common::HashDiff.diff(new_doc, ref_doc)
+          Common::HashDiff.diff(new_doc, ref_doc, ignore: ignore)
         end
 
         def dirty?
           as_update != {}
         end
 
+        # It consolidates all the changes carried by `doc` by setting it as `original_doc`.
         def consolidate!
-          raise UnlinkedModel.new  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
@@ -98,20 +106,39 @@ module Ecoportal
           end
         end
 
-        def reset!
-          raise UnlinkedModel.new  unless linked?
-          new_doc = JSON.parse(original_doc.to_json)
-          if is_root?
-            @doc = new_doc
+        # 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`
+        #   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?
+
+          if key
+            if self.respond_to?(key) && child = self.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)
+            end
           else
-            dig_set(_parent.doc, [_key].flatten, new_doc)
+            new_doc = JSON.parse(original_doc.to_json)
+            if is_root?
+              @doc = new_doc
+            else
+              dig_set(_parent.doc, [_key].flatten, new_doc)
+            end
           end
         end
 
-        # def pretty_print
-        #   puts JSON.pretty_generate(as_json)
-        #   self
-        # end
+        def print_pretty
+          puts JSON.pretty_generate(as_json)
+          self
+        end
 
         protected
 
@@ -133,6 +160,17 @@ module Ecoportal
           end
         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]) || []
+
+          value    = value.uniq
+          # preserve original order to avoid false updates
+          doc[key] = ((ini_vals & value) + (value - ini_vals)).compact
+        end
+
       end
     end
   end

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

@@ -27,7 +27,7 @@ module Ecoportal
 
           log(:info) { "Processing batch responses" }
 
-          response.body.each.with_index do |subresponse, idx|
+          body_data(response.body).each.with_index do |subresponse, idx|
             callback = @operations[idx][:callback]
             status   = subresponse["status"]
             body     = subresponse["response"]
@@ -97,6 +97,12 @@ module Ecoportal
 
         private
 
+        # Hook for other api versions to obtain the raw data of a response
+        # @note this was introduced to allow `v2` to reuse this class
+        def body_data(body)
+          body
+        end
+
         def log_batch_response(operation, response)
           level = response.success?? :debug : :warn
           log(:info) { "BATCH #{operation[:method]} #{operation[:path]}" }

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

@@ -21,9 +21,9 @@ module Ecoportal
           end
         end
 
-        def pretty_print
+        def print_pretty
           if success?
-            each(&:pretty_print)
+            each(&:print_pretty)
           else
             puts "Request failed."
           end

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

@@ -10,6 +10,9 @@ module Ecoportal
       #     - to return `HTTP::Response` ([response.rb](https://github.com/httprb/http/blob/master/lib/http/response.rb))
       # @attr_reader logger [Logger] the logger.
       class Client
+        include Common::ElasticApmIntegration
+        DELAY_REQUEST_RETRY = 5
+
         attr_accessor :logger
 
         # @note the `api_key` will be automatically added as parameter `X-ApiKey` in the header of the http requests.
@@ -17,11 +20,14 @@ module Ecoportal
         # @param version [String] it is part of the base url and will determine the api version we query against.
         # @param host [String] api server domain.
         # @param logger [Logger] an object with `Logger` interface to generate logs.
+        # @param response_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: "live.ecoportal.com", logger: nil)
+        def initialize(api_key:, version: "v1", host: "live.ecoportal.com", logger: nil, response_logging: false)
           @version  = version
           @api_key  = api_key
           @logger   = logger
+          @host     = host
+          @response_logging_enabled = response_logging
           if host.match(/^localhost|^127\.0\.0\.1/)
             @base_uri = "http://#{host}/api/"
           else
@@ -31,7 +37,6 @@ module Ecoportal
           if @api_key.nil? || @api_key.match(/\A\W*\z/)
             log(:error) { "Api-key missing!" }
           end
-          @response_logging_enabled = true
         end
 
         # Logger interface.
@@ -106,7 +111,7 @@ module Ecoportal
         # basic HTTP connection to the block.
         # @yield [http] launch specific http request.
         # @yieldparam http [HTTP] the http connection.
-        # @yieldreturn [Common::Response] the basic custom reponse object.
+        # @yieldreturn [Common::Response] the basic custom response object.
         # @return [Common::Reponse] the basic custom response object.
         def request
           wrap_response yield(base_request)
@@ -140,22 +145,15 @@ module Ecoportal
           @base_uri+@version+path
         end
 
-        def without_response_logging(&block)
-          begin
-            @response_logging_enabled = false
-            yield self
-          ensure
-            @response_logging_enabled = true
-          end
-        end
-
         private
 
-        def instrument(method, path, data = nil)
+        def instrument(method, path, data = nil, &block)
+          raise "Expected block" unless block
           start_time = Time.now.to_f
-          log(:info) { "#{method} #{url_for(path)}" }
+          log(:info)  { "#{method} #{url_for(path)}" }
           log(:debug) { "Data: #{JSON.pretty_generate(data)}" }
-          yield.tap do |result|
+
+          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)
@@ -165,6 +163,33 @@ module Ecoportal
             end if @response_logging_enabled
           end
         end
+
+        # Helper to ensure unexpected server errors do not bring client scripts immediately down
+        def with_retry(attempts = 3, delay = DELAY_REQUEST_RETRY, error_safe: true, &block)
+          response = nil
+          attempts.times do |i|
+            remaining = attempts - i - 1
+            begin
+              response = block.call
+            rescue HTTP::ConnectionError => e
+              raise unless error_safe && remaining > 0
+              log(:error) { "Got connection error: #{e.message}" }
+              response = with_retry(remaining, error_safe: error_safe, &block)
+            rescue IOError => e
+              raise unless error_safe && remaining > 0
+              log(:error) { "Got IO error: #{e.message}" }
+              response = with_retry(remaining, error_safe: error_safe, &block)
+            end
+            return response unless unexpected_server_error?(response.status)
+            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
+        end
+
       end
     end
   end

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

@@ -0,0 +1,112 @@
+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/hash_diff.rb

@@ -5,15 +5,16 @@ module Ecoportal
         ID_KEYS = %w[id]
 
         class << self
-          def diff(a, b)
-            return a if a.class != b.class
+
+          def diff(a, b, ignore: [])
             case a
             when Hash
               {}.tap do |diffed|
                 a.each do |key, a_value|
-                  b_value = b[key]
-                  next if a_value == b_value && !ID_KEYS.include?(key)
-                  diffed[key] = diff(a_value, b_value)
+                  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
@@ -22,10 +23,10 @@ module Ecoportal
                 end
               end
             when Array
-              return a unless a.length == b.length
+              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)
+                diff(a_value, b_value, ignore: ignore)
               end.reject do |el|
                 el == {}
               end

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

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

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

@@ -40,9 +40,9 @@ module Ecoportal
           response.success?
         end
 
-        def pretty_print
+        def print_pretty
           if success?
-            each(&:pretty_print)
+            each(&:print_pretty)
           else
             puts "Request failed."
           end

data/lib/ecoportal/api/common.rb

@@ -10,6 +10,7 @@ require 'ecoportal/api/common/hash_diff'
 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/client'
 require 'ecoportal/api/common/response'
 require 'ecoportal/api/common/wrapped_response'

data/lib/ecoportal/api/errors/base.rb

@@ -0,0 +1,8 @@
+module Ecoportal
+  module API
+    module Errors
+      class Base < StandardError
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module Ecoportal
+  module API
+    module Errors
+      class TimeOut < Errors::Base
+      end
+    end
+  end
+end

data/lib/ecoportal/api/errors.rb

@@ -0,0 +1,9 @@
+module Ecoportal
+  module API
+    module Errors
+    end
+  end
+end
+
+require 'ecoportal/api/errors/base'
+require 'ecoportal/api/errors/time_out'