ecoportal-api 0.8.3 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a66f25a41e7da2e5d0d38efe75ef485e8c4e830a7af80d458170e1f9e44352a9
-  data.tar.gz: a3b1060723814238dc9b4bbfaa4098b0ae8d8f17320ba4dc9b9c3e33a0a9095c
+  metadata.gz: dc651f2474f74b8f767c9df5b4611bd8adefdff75f8e25365135c89561229738
+  data.tar.gz: cb7a8ff5c0c03ba7e371f987d6b277c001b33e57716ab6cf03628d28bac53b61
 SHA512:
-  metadata.gz: e0fe445e561bbefac97f7fb2eaa7e7b926f60310a0f98d9304f214321c039b04cf610cedeb46b0e5b2ba763139feaba5385df7f4dc2f855327a2f45b03f16888
-  data.tar.gz: e121969d12d78aded1030e8ff07ef92ab5d71f73b69bc05e4332ff8cc42f7f6e6d43bb6c9143ddfd5a523558e6b928f96d36af2973c0550b1ae9dc200ab149c3
+  metadata.gz: f89285565edeaa9cbe4a98970bae8602a943c7c865121a89782f512353a8be74529578eecb4f48e893f546f172425dd38af0759412f53b8fc3a91989d6dbe52a
+  data.tar.gz: 4f51e3e6d080745261c033acf511fdd341ebf9f97003f4dda5067c49c9ef51adf966c51cf268e4991e741b45c803fc6c1e821051832c090ba2c685f03c4eaa7d

data/CHANGELOG.md

@@ -1,8 +1,34 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [0.8.4] - 2021-10-xx
 
-## [0.8.3] - 2021-05-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

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

@@ -20,12 +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
@@ -35,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.
@@ -144,15 +145,6 @@ 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, &block)
@@ -173,12 +165,26 @@ module Ecoportal
         end
 
         # Helper to ensure unexpected server errors do not bring client scripts immediately down
-        def with_retry(attempts = 3, delay = DELAY_REQUEST_RETRY)
+        def with_retry(attempts = 3, delay = DELAY_REQUEST_RETRY, error_safe: true, &block)
           response = nil
           attempts.times do |i|
-            response = yield
+            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

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

@@ -25,7 +25,7 @@ module Ecoportal
         private
 
         def unexpected_server_error?(code)
-          code && (code >= 500) && (code <= 599)
+          !code || ((code >= 500) && (code <= 599)) || (code <= 99)
         end
 
         # finalizer to stop the agent

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

@@ -6,6 +6,7 @@ module Ecoportal
         passthrough :organization, :pages, :page_editor, :registers, :tasks
         passthrough :person_core, :person_core_create, :person_core_edit
         passthrough :person_details, :person_account, :person_abilities
+        passthrough :visitor_management, :broadcast_notifications, :cross_register_reporting
       end
     end
   end

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

@@ -36,9 +36,16 @@ module Ecoportal
           puts "\n" unless silent
           loop do
             params.update(cursor_id: cursor_id) if cursor_id
+            body = nil; response = nil
+            loop do
+              response = client.get("/people", params: params)
+              body     = response && body_data(response.body)
+              break if response.success?
+              puts "Request failed - Status #{response.status}: #{body}"
+            end
             response = client.get("/people", params: params)
-            body     = response && body_data(response.body)
-            raise "Request failed - Status #{response.status}: #{body}" unless response.success?
+            #body     = response && body_data(response.body)
+            #raise "Request failed - Status #{response.status}: #{body}" unless response.success?
 
             unless silent || (total = body["total_results"]) == 0
               results += body["results"].length
@@ -117,27 +124,27 @@ module Ecoportal
         # Creates a `BatchOperation` and yields it to the given bock.
         # @yield [batch_op] adds multiple api requests for the current batch.
         # @yieldparam batch_op [BatchOperation]
+        # @param job_mode [Boolean] whether or not it should use batch jobs
+        # @return [Ecoportal::API::Common::Response] the results of the batch
         def batch(job_mode: true, &block)
           return job(&block) if job_mode
           operation = Common::BatchOperation.new("/people", person_class, logger: client.logger)
           yield operation
           # The batch operation is responsible for logging the output
-          client.without_response_logging do
-            client.post("/people/batch", data: operation.as_json).tap do |response|
-              operation.process_response(response)
-            end
+          client.post("/people/batch", data: operation.as_json).tap do |response|
+            operation.process_response(response)
           end
         end
 
+        # @return [Ecoportal::API::Common::Response] the results of the batch job
         def job
           operation = Common::BatchOperation.new("/people", person_class, logger: client.logger)
           yield operation
-          # The batch operation is responsible for logging the output
           job_id = create_job(operation)
           status = wait_for_job_completion(job_id)
 
           if status&.complete?
-            operation.process_response job_result(job_id, operation)
+            job_result(job_id, operation)
           else
             msg = "Job `#{job_id}` not complete. Probably timeout after #{JOB_TIMEOUT} seconds. Current status: #{status}"
             raise API::Errors::TimeOut.new msg
@@ -165,12 +172,10 @@ module Ecoportal
           )
         end
 
+        # @return [Ecoportal::API::Common::Response] the results of the batch job
         def job_result(job_id, operation)
-          # The batch operation is responsible for logging the output
-          client.without_response_logging do
-            client.get("/people/job/#{CGI.escape(job_id)}").tap do |response|
-              operation.process_response(response)
-            end
+          client.get("/people/job/#{CGI.escape(job_id)}").tap do |response|
+            operation.process_response(response)
           end
         end
 
@@ -187,12 +192,11 @@ module Ecoportal
           end
         end
 
+        # @return [String] the `id` of the created batch job
         def create_job(operation)
           job_id = nil
-          client.without_response_logging do
-            client.post("/people/job", data: operation.as_json).tap do |response|
-              job_id = body_data(response.body)["id"] if response.success?
-            end
+          client.post("/people/job", data: operation.as_json).tap do |response|
+            job_id = body_data(response.body)["id"] if response.success?
             raise "Could not create job - Error (#{response.status}): #{body_data(response.body)}" unless job_id
           end
           job_id

data/lib/ecoportal/api/version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    VERSION = "0.8.3"
+    VERSION = "0.8.4"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.8.4
 platform: ruby
 authors:
 - Tapio Saarinen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-24 00:00:00.000000000 Z
+date: 2021-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler