ecoportal-api 0.7.4 → 0.8.4

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

@@ -2,29 +2,26 @@ module Ecoportal
   module API
     class Internal
       class Account < Common::BaseModel
-        passthrough :policy_group_ids, :landing_page_id, :permissions_preset, :permissions_custom,
-          :preferences, :prefilter, :login_provider_ids, :starred_ids, :accept_eula,
-          :send_invites, :default_tag
+        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"
+        ]
+        passthrough *PROPERTIES.map(&:to_sym)
 
         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  :preferences, klass: :preferences_class
 
         # 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)
-          unless value.is_a?(Array)
-            raise "policy_group_ids= needs to be passed an Array, got #{value.class}"
-          end
-
-          value.uniq!
-          ini_ids = (original_doc && original_doc["policy_group_ids"]) || []
-          # preserve original order to avoid false updates
-          doc["policy_group_ids"] = (ini_ids & value) + (value - ini_ids)
-          doc["policy_group_ids"].compact
+          set_uniq_array_keep_order("policy_group_ids", value)
         end
 
         # @return [Array<String>] the policy group ids of this user.
@@ -34,10 +31,7 @@ module Ecoportal
 
         # Sets the `login_provider_ids`
         def login_provider_ids=(value)
-          unless value.is_a?(Array)
-            raise "login_provider_ids= needs to be passed an Array, got #{value.class}"
-          end
-          doc["login_provider_ids"] = value.compact
+          set_uniq_array_keep_order("login_provider_ids", value)
         end
 
         # @return [Array<String>] the login provider ids of this user.
@@ -47,10 +41,7 @@ module Ecoportal
 
         # Sets the `starred_ids`
         def starred_ids=(value)
-          unless value.is_a?(Array)
-            raise "starred_ids= needs to be passed an Array, got #{value.class}"
-          end
-          doc["starred_ids"] = value.compact
+          set_uniq_array_keep_order("starred_ids", value)
         end
 
         # @return [Array<String>] the starred page ids of this user.
@@ -58,20 +49,6 @@ module Ecoportal
           doc["starred_ids"] ||= []
         end
 
-        # Sets the `permissions_preset`.
-        # @note basically the same as `permissions_preset=` but when `"custom"`, it's changed to `nil`
-        # @param value [nil, String] preset name.
-        def preset=(value)
-          self.permissions_preset = value == "custom" ? nil : value
-        end
-
-        # Gets the `permissions_preset`.
-        # @note basically the same as `permissions_preset` but when 'nil', it returns `"custom"` instead
-        # @return [nil, String] preset name.
-        def preset
-          self.permissions_preset.nil? ? "custom" : self.permissions_preset
-        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)
@@ -88,15 +65,16 @@ module Ecoportal
 
         def as_json
           super.tap do |hash|
-            if preset == "custom"
-              hash["permissions_custom"] = permissions.as_json
-            else
-              hash.delete "permissions_custom"
-            end
+            hash["permissions_custom"] = permissions.as_json
+            hash["permissions_merged"] = perms_merged.as_json
             hash["preferences"] = preferences.as_json
           end
         end
 
+        def as_update(ref = :last, ignore: [])
+          super(ref, ignore: ignore | ["user_id", "permissions_merged", "prefilter"])
+        end
+
       end
     end
   end

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

@@ -3,9 +3,10 @@ module Ecoportal
     class Internal
       class Permissions < Common::BaseModel
         passthrough :files, :data, :reports
-        passthrough :organization, :person_core, :person_core_create, :person_core_edit
-        passthrough :person_account, :person_details
-        passthrough :pages, :page_editor, :registers, :tasks
+        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/internal/person.rb

@@ -11,10 +11,14 @@ module Ecoportal
           super.update("account" => account&.as_json)
         end
 
+        def as_update(ref = :last, ignore: [])
+          super(ref, ignore: ignore | ["user_id", "permissions_merged", "prefilter"])
+        end
+
         # Sets the Account to the person, depending on the paramter received:
         #  - `nil`: blanks the account.
         #  - `Account`: sets a copy of the object param as account.
-        #  - `Hash`: slices the properties of `Account`.
+        #  - `Hash`: slices the properties of `Account` (keeping the value of `user_id` if there was already account).
         # @note this method does not make dirty the account (meaning that `as_json` will be an empty hash `{}`)
         # @param value [nil, Account, Hash] value to be set.
         # @return [nil, Account] the resulting `Account` set to the person.
@@ -25,7 +29,9 @@ module Ecoportal
           when Internal::Account
             doc["account"] = JSON.parse(value.to_json)
           when Hash
-            doc["account"] = value.slice(*%w[policy_group_ids default_tag landing_page_id permissions_preset permissions_custom preferences prefilter login_provider_ids starred_ids])
+            user_id = account.user_id if account
+            doc["account"] = value.slice(*Internal::Account::PROPERTIES)
+            doc["account"]["user_id"] = user_id if user_id
           else
             # TODO
             raise "Invalid set on account: Need nil, Account or Hash; got #{value.class}"

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

@@ -36,11 +36,19 @@ 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)
-            raise "Request failed - Status #{response.status}: #{response.body}" unless response.success?
+            #body     = response && body_data(response.body)
+            #raise "Request failed - Status #{response.status}: #{body}" unless response.success?
 
-            unless silent || (total = response.body["total_results"]) == 0
-              results += response.body["results"].length
+            unless silent || (total = body["total_results"]) == 0
+              results += body["results"].length
               percent  = results * 100 / total
               msg      = "People GET"
               msg     += " (search=#{params[:q]})" if params.key?(:q)
@@ -48,10 +56,10 @@ module Ecoportal
               $stdout.flush
             end
 
-            response.body["results"].each do |person|
+            body["results"].each do |person|
               yield person_class.new(person)
             end
-            break unless (cursor_id = response.body["cursor_id"])
+            break unless (cursor_id = body["cursor_id"])
           end
           self
         end
@@ -70,10 +78,13 @@ module Ecoportal
         # Gets a person via api.
         # @note if the request has `success?` the returned `object.result` gives an object with that `Person`.
         # @param doc [String, Hash, Person] data containing an `id` (internal or external) of the target person.
-        # @return [WrappedResponse] an object with the api response.
+        # @return [Person] the person with `id` (internal or external) contained in `doc`.
         def get(doc)
-          response = client.get("/people/"+CGI.escape(get_id(doc)))
-          Common::WrappedResponse.new(response, person_class)
+          id       = get_id(doc)
+          response = client.get("/people/"+CGI.escape(id))
+          body     = body_data(response.body)
+          return person_class.new(body) if response.success?
+          raise "Could not get person #{id} - Error #{reponse.status}: #{body}"
         end
 
         # Requests an update of a person via api.
@@ -107,35 +118,36 @@ module Ecoportal
         # @return [Response] an object with the api response.
         def delete(doc)
           id = get_id(doc)
-            client.delete("/people/"+CGI.escape(id))
+          client.delete("/people/"+CGI.escape(id))
         end
 
         # 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
-            raise "Job `#{job_id}` not complete. Probably timeout after #{JOB_TIMEOUT} seconds. Current status: #{status}"
+            msg = "Job `#{job_id}` not complete. Probably timeout after #{JOB_TIMEOUT} seconds. Current status: #{status}"
+            raise API::Errors::TimeOut.new msg
           end
         end
 
@@ -150,22 +162,20 @@ module Ecoportal
         JobStatus = Struct.new(:id, :complete?, :errored?, :progress)
         def job_status(job_id)
           response = client.get("/people/job/#{CGI.escape(job_id)}/status")
-
-          raise "Status error" unless response.success?
+          body     = response && body_data(response.body)
+          raise "Status error (#{response.status}) - Errors: #{body}" unless response.success?
           JobStatus.new(
-            response.body["id"],
-            response.body["complete"],
-            response.body["errored"],
-            response.body["progress"]
+            body["id"],
+            body["complete"],
+            body["errored"],
+            body["progress"]
           )
         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
 
@@ -182,15 +192,22 @@ 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 = response.body["id"]
-            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
         end
+
+        # 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
+
       end
     end
   end

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

@@ -59,17 +59,13 @@ module Ecoportal
           unless value.is_a?(Array)
             raise "filter_tags= needs to be passed an Array, got #{value.class}"
           end
-          end_tags = value.map do |tag|
+          end_tags = value.compact.map do |tag|
             unless tag.match(VALID_TAG_REGEX)
               raise "Invalid filter tag #{tag.inspect}"
             end
             tag.upcase
-          end.uniq
-
-          ini_tags = (original_doc && original_doc["filter_tags"]) || []
-          # preserve original order to avoid false updates
-          doc["filter_tags"] = (ini_tags & end_tags) + (end_tags - ini_tags)
-          doc["filter_tags"].compact
+          end
+          set_uniq_array_keep_order("filter_tags", end_tags)
         end
 
         # @return [Array<String>] the filter tags of this person.
@@ -81,6 +77,10 @@ module Ecoportal
           super.merge "details" => details&.as_json
         end
 
+        def as_update(ref = :last, ignore: [])
+          super(ignore: ignore | ["subordinates"])
+        end
+
         # Sets the PersonDetails to the person, depending on the paramter received:
         #  - `nil`: blanks the details.
         #  - `PersonDetails`: sets a copy of the object param as details.

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

@@ -6,25 +6,24 @@ module Ecoportal
         passthrough :id, :alt_id, :type, :name, :shared, :multiple
 
         def value
-          return @value if defined?(@value)
-          @value = case type
-                   when "text", "phone_number", "number", "boolean", "select"
-                     doc["value"]
-                   when "date"
-                     if doc["value"]
-                       maybe_multiple(doc["value"]) do |v|
-                         Date.iso8601(v)
-                       end
-                     end
-                   else
-                     raise "Unknown type #{type}"
-                   end
+          case type
+          when "text", "phone_number", "number", "boolean", "select"
+           doc["value"]
+          when "date"
+           if doc["value"]
+             maybe_multiple(doc["value"]) do |v|
+               Date.iso8601(v)
+             end
+           end
+          else
+           raise "Unknown type #{type}"
+          end
         end
 
         def value=(value)
           case type
           when "text", "phone_number", "select"
-            doc["value"] = @value = maybe_multiple(value) do |v|
+            doc["value"] = maybe_multiple(value) do |v|
               v&.to_s
             end
           when "number"
@@ -33,23 +32,21 @@ module Ecoportal
                 raise "Invalid number type #{v.class}"
               end
             end
-            doc["value"] = @value = value
+            doc["value"] = value
           when "boolean"
-            doc["value"] = @value = !!value
+            doc["value"] = !!value
           when "date"
             maybe_multiple(value) do |v|
               unless v.nil? || v.respond_to?(:to_date)
                 raise "Invalid date type #{v.class}"
               end
             end
-            @value       = value
-            doc["value"] = maybe_multiple(@value) do |v|
+            doc["value"] = maybe_multiple(value) do |v|
               v&.to_date&.to_s
             end
           else
             raise "Unknown type #{type}"
           end
-          @value
         end
 
         def maybe_multiple(value)

data/lib/ecoportal/api/version.rb

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

data/lib/ecoportal/api.rb

@@ -2,6 +2,7 @@ require "cgi"
 require "logger"
 require "hash-polyfill"
 require "ecoportal/api/version"
+require "dotenv/load"
 
 module Ecoportal
   module API
@@ -10,6 +11,6 @@ end
 
 require "ecoportal/api/logger"
 require "ecoportal/api/common"
+require "ecoportal/api/errors"
 require "ecoportal/api/v1"
-require "ecoportal/api/v2"
 require "ecoportal/api/internal"